angular-seed

A project seed for new angular 1.x applications

Getting Started

To get you started you can simply clone the angular-seed repository and install the dependencies:

Prerequisites

You need git to clone the angular-seed repository. You can get git from http://git-scm.com/.

We also use a number of node.js tools to initialize and test angular-seed. You must have node.js and its package manager (npm) installed. You can get them from http://nodejs.org/.

Clone angular-seed

Clone the angular-seed repository using git:

git clone https://github.com/thiren/angular-seed.git
cd angular-seed

If you just want to start a new project without the angular-seed commit history then you can do:

git clone --depth=1 -b <branch-name> https://github.com/thiren/angular-seed.git <your-project-name>

The depth=1 tells git to only pull down one commit worth of historical data.

Install Dependencies

We have two kinds of dependencies in this project: tools and client-side framework code. The tools help us manage and test the application.

• We get the tools we depend upon via npm, the node package manager
• We get the client-side framework code via bower, a front-end package manager

You can install all of the required dependencies by running the command below:

npm run setup

Behind the scenes this will call npm install followed by bower install. You should find that you have two new folders in your project.

• node_modules - contains the npm packages for the tools we need
• bower_components - contains the client-side framework files

In order to build the application you will need to install the Gulp build system globally.

npm install -g gulp

Run the Application

We have preconfigured the project with a build process and a simple development web server. This build process is written using the Gulp build system. The simplest way to build the application and start this server is:

gulp watch --env=development

The --env=development tells the build process that we want to build the application for the development environment. The build process can be executed using four different environments: development, qa, production or test. The build process will differ depending on which environment is specified when running the build.

You should find that you have one new folder in your project.

• build - contains the built angular application and all static website resources

Now browse to the app at http://localhost:9000.

Directory Layout

src/
  app/
    footer/
      footer.tpl.html
    header/
      header.controller.js
      header.module.js
      header.tpl.html
    home/
      home.tpl.html
    app.module.js
  configs/
    constants.json
  fonts/
  images/
  styles/
    main.less
  favicon.ico
  index.html
test/
  e2e/
    scenarios.js
  unit/
    header/
      header.controller.spec.js
bower.json
build.config.js
gulpfile.js
karma.config.js
package.json
protractor.conf.js

Testing

Running Unit Tests

The angular-seed app comes preconfigured with unit tests. These are written using a combination of the Mocha testing framework, the Chai assertion library and Sinon which allows us to write standalone test spies, stubs and mocks. We run the unit tests using the Karma test runner. We provide a Karma configuration file to run them.

• The configuration is found in the karma.conf.js file
• The unit tests are found next to the code they are testing or in the test/unit directory and are named as <file-name>.spec.js

The easiest way to run the unit tests is to use the supplied npm script:

npm test

This script will start the Karma test runner which will execute the unit tests.

End to end testing

The angular-seed app comes with end-to-end tests, again written in Mocha and Chai. These tests are run with the Protractor End-to-End test runner. It uses native events and has special features for Angular applications.

• the configuration is found in protractor.conf.js
• the end-to-end tests are found in test/e2e/scenarios.js

Protractor simulates interaction with a web app and verifies that the application responds correctly. Therefore, our web server needs to be serving up the application, so that Protractor can interact with it.

gulp watch

In addition, since Protractor is built upon WebDriver we need to install this. The angular-seed project comes with a predefined script to do this:

npm run update-webdriver

This will download and install the latest version of the stand-alone WebDriver tool.

Once you have ensured that the development web server hosting our application is up and running and WebDriver is updated, you can run the end-to-end tests using the supplied npm script:

npm run protractor

This script will execute the end-to-end tests against the application being hosted on the development server.

Continuous Integration

Travis CI

Travis CI is a continuous integration service, which can monitor GitHub for new commits to your repository and execute scripts such as building the app or running tests. The angular-seed project contains a Travis configuration file, .travis.yml, which will cause Travis to run your tests when you push to GitHub.

You will need to enable the integration between Travis and GitHub. See the Travis website for more instruction on how to do this.

Resources

For more information on AngularJS please check out http://angularjs.org/