Project Setup

• Set up Git locally
• Fork the repo
• Install VirtualBox
• Install Vagrant
• Install Vagrant-Berkshelf plugin $ vagrant plugin install vagrant-berkshelf`
• Request access to Okta Preview from TechOps

Spin up the Vagrant box

vagrant up
vagrant ssh
cd workspace

Set up the local environment

bundle install
echo "PORT=9292" > .env
echo "RACK_ENV=development" >> .env
bundle exec rake db:create
bundle exec rake db:migrate
bundle exec rake db:seed
RAILS_ENV=test bundle exec rake db:migrate

Run the test suite

• All the tests (javascript + rspec)
  • $ sh runtests.sh
• 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
  • $ RAILS_ENV=test bundle exec rake spec:javascript
  • To run a single test: $ RAILS_ENV=test bundle exec rake spec:javascript SPEC=my_test
• See the wiki for a guide on Manual Testing

Start the local server

• $ bundle exec foreman start (this will not return)

If your foreman is very slow, try getting a new network setup:

• $ sudo dhclient (this will give a File Exists, that's ok)
• $ bundle exec foreman start

View the dev site locally:

• http://localhost:9292/

Deploying the ReviewSite to Heroku

When deploying to a new Heroku instance (developers will NOT need to do this), please specify e-mail account settings in the following configuration variables.

Account details for sending emails from:

• MAIL_SERVER=smtp.gmail.com
• MAIL_PORT=587
• MAIL_DOMAIN=thoughtworks.org
• [email protected]
• MAIL_PASSWORD=<password>
• MAIL_TLS=true

The Address that should appear in the "from" line of the sent e-mails:

• MAIL_FULL_EMAIL="TW ReviewSite <[email protected]>"

The base domain that should be used for the links that appear in the emails.

• DOMAIN=twreviewsite.herokuapp.com

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.

• [email protected]

Questions?

• Valerie Roske, Tech Lead (varoske@thoughtworks)
• Alex Jablonski, Developer (ajablonski@thoughtworks)
• Brandon Smith, Developer (brsmith@thoughtworks)
• Whitney Behr, QA (wlbehr@thoughtworks)