Skip to content

Instantly share code, notes, and snippets.

@micjamking
Last active August 29, 2015 14:15
Show Gist options
  • Save micjamking/217e5414d1de11278b16 to your computer and use it in GitHub Desktop.
Save micjamking/217e5414d1de11278b16 to your computer and use it in GitHub Desktop.
[JavaScript] AngularJS README Template

Project Name

Requirements

Install

$ git clone git@github.com:user/project.git
$ cd project
$ npm install && bower install

Development

$ grunt serve

If you receive any command not found errors, then you're probably missing one of the Yeoman dependencies. Try running npm install -g yo and then rerunning the failed tasks.

Testing

$ grunt test

Deployment

$ grunt build
$ grunt deploy

...or you can also just run

$ grunt

...which runs all of the testing, build, and deployment tasks in sequence. It's good practice to run the build & deploy separately since build errors can prevent a successful deployment.

Builds are deployed to Heroku using the heroku-toolbelt cli. You'll need to have the Heroku Toolbelt setup with SSH keys configured and access to the repo to do deployments. If not, you may receive errors during deployment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment