This is a Rails 4.2.1 app.
This README describes the purpose of this repository and how to set up a development environment. Other sources of documentation are as follows:
- UI and API designs are in
doc/ - Server setup instructions are in
PROVISIONING.md - Staging and production deployment instructions are in
DEPLOYMENT.md
This project requires:
- Ruby 2.2.2, preferably managed using rbenv
- PhantomJS (in order to use the poltergeist gem)
- PostgreSQL must be installed and accepting connections
- Redis must be installed and running on localhost with the default port
If you need help setting up a Ruby development environment, check out this Rails OS X Setup Guide.
Run the bin/setup script. This script will:
- Check you have the required Ruby version
- Install gems using Bundler
- Create local copies of
.envanddatabase.yml - Create, migrate, and seed the database
- Run
rake testto make sure everything works. - Run
rails sto start the Rails app. - In a separate console, run
bundle exec sidekiqto start the Sidekiq background job processor.