API and web interface for Fadecandy control. For the client-side code responsible for receiving requests from the Webcandy server and running lighting configurations on the Fadecandy itself, see webcandy-client.
Requirements
Setup
To install the necessary node modules, run:
$ cd webcandy/static
$ npm install
Pipenv
This project supports Pipenv, which I recommend using for finer dependancy tracking.
$ pip install pipenv
$ pipenv install
For more info on Pipenv, you can read the docs.
virtualenv
If you don't want to use Pipenv, it is recommended that a virtual environment is used.
$ pip install virtualenv
$ virtualenv venv
The virtual environment is now created. To activate it:
- Windows:
> .\venv\Scripts\activate - Mac/Linux:
$ source ./venv/bin/activate
Please note: if you are using virtualenv, you need to make sure to activate and deactivate manually while working on the project.
Then, install the project requirements:
(venv) $ pip install -r requirements.txt
Running
Dev environment
In a development environment, Webcandy should be run using Flask:
$ flask run
Then, in a different terminal:
webcandy/webcandy/static $ npm run watch
This will watch for front-end changes and automatically rebuild the JavaScript.
- Note: If you don't see your changes in the browser, use
Ctrl/Cmd+Shift+Rto refresh and clear cache.
Server environment
To run Webcandy from a local server, activate the virtual environment and run
the server using gunicorn:
$ gunicorn 'webcandy:create_app()'
To build the front-end code, run:
webcandy/webcandy/static $ npm run build
Clients
To control LEDs, you will need to connect a client (docs).
$ pip install webcandy-client
$ wc-client RGBLover573 password123 MyClient
Login
On an independant server, if you want a user with some example data saved you can log in as "testuser1" or "testuser2", each with password "Webcandy1".
Documentation
Documentation can be found at https://webcandy.readthedocs.io/. (WIP)
Acknowledgements
- Thanks to Maksim Surguy (msurguy) for the awesome logo!