Lab Assistant

Dev setup

0. Install vagrant

1. Install ansible

2. Clone the project

    git clone https://github.com/thelabtw/lab-assistant.git
   

3. Start the vagrant vm

    vagrant up && vagrant provision
   

4. Log onto the vm

    vagrant ssh
   

5. Find the project files

    cd /vagrant
   

6. Install dependencies

    npm install
   

7. Email configuration [Optional]

    1. Run `which sendmail` in a terminal
    2. Add EMAIL_SERVER="Path to sendmail" to environment vars
    3. Turn on the toggle `email.sendEmails` in each specific environment (config/default.json, config/staging.json, config/production.json)
   

8. Run the tests

    npm test
   

9. Run the acceptance tests

    1. First set up a admin email and admin password:
            export ACCEPTANCE_EMAIL=some email here
            export ACCEPTANCE_PASSWORD=some password here
    2. Start the server:
            npm start
    3. Then run:
            npm run acceptanceTests
   

10. Start the server

     npm start
    

11. Re-bundling the UI

    The frontend code must be re-bundled whenever it changes; npm start serves the last bundled version of the UI. We have a postinstall task that bundles any time npm install is run (i.e. on deployment).

    When developing, the easiest way to keep the front-end up to date is to run the following command in a separate shell, which will watch the code and re-bundle on changes. This can be run outside of the Vagrant VM, if you have npm installed on your host machine.

     npm run bundle
    

Tests

0. Run server side tests

    npm run serverTests
   

1. Run client side tests

    npm run componentTests
   

2. Run a specific server side test

    NODE_ENV=test node --harmony node_modules/jasmine/bin/jasmine.js spec/integration/membersSpec.js
   

3. Run smoke tests against an external target

    NODE_ENV=test INSTANCE_URL=http://myinstance.mydomain.com node --harmony node_modules/jasmine/bin/jasmine.js spec/integration
   

Utility scripts

0. Migrate the database (run automatically as part and npm start or npm test)

    ./node_modules/sequelize-cli/bin/sequelize db:migrate
   

1. Create a new migration

    ./node_modules/sequelize-cli/bin/sequelize migration:create --config config/db.json --name <migration_name>
   

2. Create an admin user to access the organiser views

    npm run createAdmin
   

Pull a copy of the staging db from heroku

0. heroku pg:backups capture --app <app_name>

1. curl -o db/dumps/latest.dump heroku pg:backups public-url

2. (in the vm) pg_restore --verbose --clean --no-acl --no-owner -h localhost -U lab-assistant -d lab-assistant db/dumps/latest.dump

Happy hacking!

Optional setup

JShint

0. Install plugin

WebStorm

0. Install webstorm

1. Open preferences -> Languages and frameworks

2. Change javascript to ECMAScript 6

3. Setup run configuration to node and "javascript/file" to be bin/www

4. Optionally install vagrant plugin