Project Name

Usage

How to use this project.

Development

This project should use: - SCSS for styles - HTML5 for views - ECMAScript 5 for all code

This project uses npm as the base package manager, with nodejs gulp to compile the site. You can install nodejs with npm from https://nodejs.org. At time of writing, npm v3 is painfully slow, our suggested alternative is https://yarnpkg.com/ which should be compatible with package.json defined by npm.

To install project dependencies, run npm i.

Running gulp will load up a local version for you to test with while developing. Any changes will be automatically reflected in the test site.

To compile for production use gulp build. This will compile the source app into a folder called dist.

For angular code styling guidelines please refer to https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md

This project uses ESLint to maintain a common code formatting and best practices. ESLint is compatible with most of the popular IDEs, please lookup how to integrate with your IDE. If you are not using an IDE, eslint can be run in the command line. If you have installed it globally, you can run eslint --fix . to lint the code and fix any simple errors such as spacing, this will also print out a report of all the current lint errors. If you have only installed locally, simply change the above command to ./node_modules/.bin/eslint --fix ..