broonline
Fun project for tracking the use of broon sauce at chippies
MIT License
broonline
Fun project for tracking the use of broon sauce at chippies.
Install
Before you can install the website locally you'll need to install the following prerequisites first:
Once you have mongoDB running locally, create a user with read/write access for a database which will be used by this website.
You'll need to have the following environment variables set;
Once you've done all of that, you can just checkout the code and then install it with the following commands;
$ git clone https://github.com/neocotic/broonline.git
$ cd broonline
$ npm install
Running
You just need to run the following command;
$ node index.js
Contributing
If you want to contribute to the website (legend!), please make sure you read through the following documentation first;
https://github.com/neocotic/broonline/raw/master/CONTRIBUTING.md
Bugs
If you have any problems with the website or would like to see the changes currently in development you can do so here;
https://github.com/neocotic/broonline/issues
License
See LICENSE.md for more information on our MIT license.
