https://github.com/kaltsoon/angular-boilerplate

Get started with Angular.js!
https://github.com/kaltsoon/angular-boilerplate

Last synced: 14 days ago
JSON representation

Get started with Angular.js!

• Host: GitHub
• URL: https://github.com/kaltsoon/angular-boilerplate
• Owner: Kaltsoon
• Created: 2015-10-11T06:27:56.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-20T09:42:52.000Z (about 9 years ago)
• Last Synced: 2023-04-06T05:12:19.409Z (over 1 year ago)
• Language: JavaScript
• Size: 6.71 MB
• Stars: 0
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Angular boilerplate

:exclamation: **Heads up!** Only tested with OS X and Linux. 

## Getting started

* Fork this repository and clone it

* Install [Node](https://nodejs.org/en/)

* Install [Bower](http://bower.io/) by running `npm install -g bower`

* Install [Gulp](http://gulpjs.com/) by running `npm install --global gulp`

* Go to the cloned repository folder and run `npm install`

* Start the development server by running `npm start`

  * Server will be running at [http://localhost:3000](http://localhost:3000)

* **Learn Angular [here](https://docs.angularjs.org/tutorial)**

## Workflow

All files are in the `public` folder. `public/index.html` file has the initial view. Script files are in the `public/app` folder. Application module is located in the `public/app/main.js` file. Example controller can be found in the `public/app/controllers/todo-list.controller.js` file.

`gulpfile.js` has the [Gulp](http://gulpjs.com/) configuration. When you start developing your Angular application run `gulp serve`. After running the `serve` task, all script files in the `public/app` folder will be watched and when changed, script files will be minified into `public/dist/scripts.min.js` file.

### Example workflow

* Run `gulp serve`

* Change a file in the `public/app/controllers` folder

* See the changes at [http://localhost:3000](http://localhost:3000)

### Tips :thumbsup:

* Watch [this](https://www.youtube.com/watch?v=dwSLFai8ovQ) screencast to learn more about Gulp

## Tests

Tests can be executed by running `npm test`. `karma.conf.js` has the [Karma](http://karma-runner.github.io/0.13/index.html) configuration which loads `public/dist/scripts.js` file and `public/bower_components/angular/angular.min.js` file into the browser and runs the tests in `tests` folder. **Change this configuration when you add dependencies to your application**.

### Tips :thumbsup:

* You can read more about how to test your Angular application [here](https://docs.angularjs.org/guide/unit-testing)

* Read more about Karma configurations [here](http://karma-runner.github.io/0.13/config/configuration-file.html)

* It's highly recommended to use a [travis](https://github.com/yeoman/generator-angular) as a CI-server

## Heroku deployment

* **[Sign up](https://signup.heroku.com/login) to Heroku**

* Install [Heroku toolbelt](https://toolbelt.heroku.com/)

* Run `heroku login`

* Go to the cloned repository folder and run `heroku create`

* Run `git push heroku master`

* Run `heroku open`