Dependencies

1. Run npm install to pull all required node_module dependencies
2. Run npm install gulp -g to install Gulp, the automated build system used for the front-end, globally.
3. Follow the instructions at http://sass-lang.com/install to install Sass locally. This is required to view the app in the browser.

Running

TODO : Integrate Gulp workflow into the express app so there is only one command for running.

1. Type gulp to run the Gulpfile which compiles, minifies, and copies front_end source files to the production directory. NOTE: You must run gulp each time you wish to view new changes from the front-end source.
2. To run:

• (Option 1) Enter the command 'npm start' to launch the app at 'localhost:3000' in a development environment
• (Option 2) Enter the command 'npm production' to launch the app at 'localhost:3000' in a production environment

Local Build Server (For Front-End folks!)

1. Type gulp watch to start a server at localhost:9000.

This server watches for changes to front-end source files and compiles and copies them over to the production. This way, you can refresh your browser and see the changes instantly instead of having to recompile manually.

Testing

1. Run the server: 'npm start'
2. Open another terminal and type 'make test' or 'npm test'

If this doesn't work, make sure you have the most up to date libraries by running 'npm install'

API Documentation

http://umass-cs-497.github.io/lecture-viewer/apiV1.html