Better than a whiteboard over the kegerator
- kaskpi - Raspberry Pi based Go data collection
- kaskduino - Arduino interface to flow sensors, RFID, etc
- Install and configure the tools you need. (Node, Mysql server, npm)/
- Clone the repo
- Run the
db-init/db-init.sqlscript against your Mysql server npm inpm run gulpnpm start- Navigate to localhost:3000, or whichever port you specified in your env variables
Docker and docker-compose files are provided and configured for development without needing to install MySQL locally.
- Set up your
.envfile with BreweryDB key and any other custom settings docker-compose up- (in a separate terminal)
npm run dev
On creation a mysql-data directory is created and the init script is run.
To reinitialize the db, delete this directory as well as the ontap_db container then rerun docker-compose.
You can also connect direclty to MySQL running on localhost:3306 when docker-compose is running.
If you plan to make changes to the codebase, here are some helpful tips.
- Placing a file named
.envin the root of the project will allow you to set env vars in bash syntax e.g.PORT=3000 - A BreweryDB API key is required. Set it with an env var named
BREWERY_DB_KEY - You can auto-compile and auto-reload the brower on changes by running
npm run dev. This will require that you run the server in another terminal - The gulp file has many helpful methods that can be called separately depending on the changes you made.
For example, you can recompile the server without building the entire project by using
npm run gulp -- compile_node
- Open an issue with your bug/feature request. Other maintainers may have helpful insight in to your request.
- Fork the repo.
- Open a pull request against the
devbranch. That is the home for latest code, whereas master will hold release versions. - Your PR must pass our status checks and a review from at least one contributor