Rails app to track reviews for Associate Consultants
Ruby JavaScript HTML CSS Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
db
documentation
infra
lib
log
packer
public
script
spec
.gitattributes
.gitconfig
.gitignore
.hound.yml
.rspec
.ruby-style.yml
.ruby-version
.vagrantplugins
Gemfile
Gemfile.lock
Procfile
Procfile.dev
README.md
Rakefile
Vagrantfile
config.ru
setup.sh

README.md

Build Status

Project Setup

Spin up the Vagrant box

  • During the provising process you will need to enter your system administrator password for the NFS share mount

    1. vagrant up
    2. vagrant ssh
    3. cd workspace

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 http://localhost:3000/

Run the test suite

  • All the tests (javascript + rspec)
    • $ 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
    • $ 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
  • 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:

  • MAIL_SERVER=smtp.gmail.com
  • MAIL_PORT=587
  • MAIL_DOMAIN=thoughtworks.org
  • MAIL_USERNAME=do-not-reply@thoughtworks.org
  • 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 <do-not-reply@thoughtworks.org>"

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_OVERRIDE=someone@somewhere.com

Questions?

Any dev questions can be sent to tw-review-site@thoughtworks.com and it will be seen by all members of the Review Site team.