Forked from ATS + EchoUser submission for USDA Innovation Challenge, https://github.com/atsid/usda-challenge
The app uses gulp to do some builds and run a static server to host the content. To get started:
- Install Node.js if you don't already have it
- Clone the git repo to a user-owned directory where you have permissions
- Get dev dependencies:
npm install - Run code quality checks:
npm test - Run the app:
npm start
This will serve up the static content at http://localhost:8000/usda-challenge, and watch for file changes to automatically refresh itself.
Optional: install gulp so you can execute it directly on the command line: npm install -g gulp.
This is optional because npm test and npm start will get you running, and they map to a local gulp from node_modules.
We use Travis-CI to build the project on every commit to the master branch. Since this currently a completely client-side app, that just means pushing to the live server.
And in this case, 'live server' means automatic free hosting on GitHub Pages by virtue of commits to the repository's gh-pages branch.
Deployment uses a gulp task to push to the gh-pages branch, where it can be viewed at http://labs.atsid.com/epa-eds/. You can do it yourself manually on the command line like so:
- Get dev dependencies:
npm install - Install gulp if you don't have it:
npm install -g gulp gulp deploy
Note again that this process happens automatically by Travis whenever commits are made to master.