README.md

SHIFTY - Vision

A new and intuitive way of controlling intelligent devices developed from first principles for the event industry.

🚀 Contribute

Feel free to check out the concepts here on GitHub, lets discuss your own ideas in Issues or check out code you want to add via Pull requests 🥳

• Type Documentation → checkout running locally (npm run doc)
• WebSocket Demo → checkout w/ running dev server: /websocketDemo
• Fixture Validation → chechkout w/ running dev server: /fixtureValidation
• Visualizer → checkout w/ running dev server: /visualizer
  • Remote → checkout w/ running dev server: /visualizer/remote

🔥 Run locally

prerequisites

• Node.js® LTS

download

This can either be done thru downloading the repos as *.zip and unpacking at said path or directly cloning the repository via cmdline.

git clone https://github.com/oshifty/vision.git <path>

install dependencies

Open the <path> in your IDE

code <path>

and install all dependencies with npm in the terminal:

npm install

run app for development

npm run dev

run tests for development

npm run test

build documentation

for development

To build the documentation website for development and watch for file changes to automatically recompile run:

npm run doc

for production

To build your plugin for production run:

npm run doc:build

lint

npm run lint

format

npm run format