oagarcia / penguin-report

Catch your penguins and notify in advance!!!

Penguin Basecamp Report

Installation

1. Install Redis http://jasdeep.ca/2012/05/installing-redis-on-mac-os-x/ and be sure it is running. Alternatively (and if you have docker installed), you can run npm run docker:redis to create a redis container.
2. Ask for env vars you need to set (sensible data)
3. npm install
4. npm start or npm run debug (paused by default in the first line)
5. Check app in defined port (defaults to port 3000)
6. Be moderate with the notify button!!! - hidden in the UI to avoid improper use
7. Happy penguins ;)

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D