A Firewatch inspired index application for fires and incidents
Fireplace aims to help watchers, rangers and anyone to see incidents occurred on park and report news.
Fireplace is built using Rails and RethinkDB, so here is what you are going to need:
- Ruby 2.2.4 +
- Rails Gem installed
gem install rails(Current version 4.2.6) - RethinkDB for your platform
- If needed you can set
RETHINKDB_URLto customize the url for RethinkDB. - Node.js and Bower installed
npm i -g bower
To use Google Maps you are going to need an API Key which you can find an excellent documentation on how to get and everything else on their page. Then set the FIREPLACE_MAPS_KEY environment variable with the value of your key.
Use the commands above to set up the project:
bundle install --without productionfor gem dependenciesbower installfor asset dependenciesrake nobrainer:seedto seed the Databaserails sto serve
Then open your browser on localhost:3000
To keep the code beautiful we use RuboCop as static code analyzer, to run it you need to install via bundle or by running gem install rubocop, basic usages can be found on the documentation.
RSpec is powered by a Guard, to run it and all tests you use the following commands: bundle exec guard and it will start to watch your specs folder
Check out Mkdocs getting started
Icons made by Freepik from Flaticon and is licensed by Creative Commons BY 3.0