Kask

Better than a whiteboard over the kegerator

Related Repositories

kaskpi - Raspberry Pi based Go data collection
kaskduino - Arduino interface to flow sensors, RFID, etc

Local Installation

Install and configure the tools you need. (Node, Mysql server, npm)/
Clone the repo
Run the db-init/db-init.sql script against your Mysql server
npm i
npm run gulp
npm start
Navigate to localhost:3000, or whichever port you specified in your env variables

Docker Development

Docker and docker-compose files are provided and configured for development without needing to install MySQL locally.

Set up your .env file 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.

Development

If you plan to make changes to the codebase, here are some helpful tips.

Placing a file named .env in 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

Contribution