gregfitch / tutor-js

:mortar_board: Javascript frontend for openstax tutor

tutor-js

The JavaScript client for openstax Tutor.

Install

1. install nodejs from the website or using http://brew.sh if you’re already using it
2. npm install -g gulp bower to install gulp and bower globally
3. git clone https://github.com/openstax/tutor-js to the directory of your choice

• If you don’t have git installed you can install homebrew and then brew install git

1. cd tutor-js
2. npm install
3. bower install
4. gulp serve
5. Point your browser to http://localhost:8000 to use the mock data in /api

Development

• gulp test runs unit tests
• gulp prod builds minified files for production
• gulp serve builds files and starts up a static webserver
• gulp dev watches and rebuilds CSS and JS files and starts webserver
• gulp tdd does what dev does plus reruns unit tests

Use PORT=8000 gulp serve to change the default webserver port.

After local updates are made:

1. stop gulp serve
2. npm install
3. if bower.json changed, bower install
4. restart gulp serve

Pre-production

Before starting up vagrant, you can debug using a more production-like config by:

1. gulp prod
2. unzip /dist/archive.tar.gz into an assets/ directory
3. serve the assets/ directory via NGINX or something with CORS enabled
4. update the paths in tutor-server/conf/secrets.yml to point to http://localhost:[NGINX-PORT]/assets/tutor.min-####.css and tutor.min-####.js respectively
5. in tutor-server run rails s
6. go to http://localhost:3001