- Set up Git locally
- Clone the repo
- Add application.yml file from 1Password to config/
Spin up the Vagrant box
During the provising process you will need to enter your system administrator password for the NFS share mount
Install Dependencies and Setup Database
- Run setup.sh OR run the following
$ bundle install $ bundle exec rake db:drop db:create db:migrate db:seed $ RAILS_ENV=test bundle exec rake db:drop db:create db:migrate
Start the local server
$ bundle exec puma
Go to the local site through Okta Preview
View the dev site locally at
Run the test suite
$ bundle exec rake spec:ci
- All the rspec tests
$ bundle exec rspec
- One rspec test file
$ bundle exec rspec spec/.../..._spec.rb
- One rspec test block
$ bundle exec rspec spec/.../..._spec.rb:40
- Run the Jasmine tests
- To run a single test:
- See the wiki for a guide on Manual Testing
- You can run the functional tests on your local machine (not vagrant) to debug them in Firefox
Deploying the ReviewSite to Heroku
When deploying to a new Heroku instance, please specify e-mail account settings in the following configuration variables.
Account details for sending emails from:
The Address that should appear in the "from" line of the sent e-mails:
MAIL_FULL_EMAIL="TW ReviewSite <email@example.com>"
The base domain that should be used for the links that appear in the emails.
In order to prevent the mailer from sending e-mail on non-production heroku instance, it is possible to redirect all e-mail to an address that you control.
Any dev questions can be sent to firstname.lastname@example.org and it will be seen by all members of the Review Site team.