Aurelia demo using best practices for managing a logged in user.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 4a97132 Sep 22, 2015
Failed to load latest commit information.
build fix(build): include source in source maps. resolve #111 Jun 24, 2015
doc chore(all): prepare release 0.17.0 Aug 14, 2015
img initial commit Aug 14, 2015
src design tweaks for blog Sep 22, 2015
styles initial commit Sep 22, 2015
test fix(e2e): switch from flickr to users navigation test Aug 13, 2015
.editorconfig chore(*): initial release 0.3.1 Dec 12, 2014
.gitignore chore(build): update babel and add code coverage task Jun 8, 2015
.jshintrc chore(build): re-organize gulp files Feb 5, 2015
.npmignore chore(*): initial release 0.3.1 Dec 12, 2014 doc(contributing): add github standard file Feb 5, 2015
LICENSE doc(all): update company name Dec 31, 2014 doc(README): add bundling insturctions Aug 13, 2015
aurelia.protractor.js feat(e2e): add protractor plugin, add waitMethods Feb 17, 2015
aureliafile.js doc(README): add bundling insturctions Aug 13, 2015
config.js initial commit Sep 22, 2015
favicon.ico chore(favicon): update to latest design Apr 13, 2015
gulpfile.js doc(gulpfile): add inline documentation for the gulpfiles. resolve #29 Feb 7, 2015
index.html fix(index): update font awesome reference Aug 3, 2015
jsconfig.json add jsconfig.json so Visual Studio Code can understand we want ES6 fe… Jul 8, 2015
karma.conf.js fix(karma): properly set jspm paths for karma May 9, 2015
package.json initial commit Sep 22, 2015
protractor.conf.js feat(e2e): add protractor plugin, add waitMethods Feb 17, 2015


ZenHub Join the chat at

This skeleton is part of the Aurelia platform. It sets up a standard navigation-style app using gulp to build your ES6 code with the Babel compiler. Karma/Protractor/Jasmine testing is also configured.

To keep up to date on Aurelia, please visit and subscribe to the official blog. If you have questions, we invite you to join us on Gitter. If you would like to have deeper insight into our development process, please install the ZenHub Chrome Extension and visit any of our repository's boards. You can get an overview of all Aurelia work by visiting the framework board.

Running The App

To run the app, follow these steps.

  1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
  2. From the project folder, execute the following command:
npm install
  1. Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
  1. Ensure that jspm is installed. If you need to install it, use the following command:
npm install -g jspm

Note: jspm queries GitHub to install semver packages, but GitHub has a rate limit on anonymous API requests. It is advised that you configure jspm with your GitHub credentials in order to avoid problems. You can do this by executing jspm registry config github and following the prompts.

  1. Install the client-side dependencies with jspm:
jspm install -y

Note: Windows users, if you experience an error of "unknown command unzip" you can solve this problem by doing npm install -g unzip and then re-running jspm install.

  1. To run the app, execute the following command:
gulp watch
  1. Browse to http://localhost:9000 to see the app. You can make changes in the code found under src and the browser should auto-refresh itself as you save files.

Note: At present there is a bug in the HTMLImports polyfill which only occurs on IE. We have submitted a pull request to the team with the fix. In the mean time, if you want to test on IE, you can work around the issue by explicitly adding a script tag before you load system.js. The script tag should look something like this (be sure to confirm the version number):

<script src="jspm_packages/github/webcomponents/webcomponentsjs@0.5.2/HTMLImports.js"></script>


Bundling is performed by Aurelia CLI. If you don't have the cli installed, use the following command:

 npm install -g aurelia-cli

You can create bundles for both javascript modules and Aurelia views/templates with this command:

aurelia bundle

Note that, we have an aureliafile.js placed in the root of the project. CLI uses this file for various configuration that includes bundling. To learn more about other configuration options please visit CLI Documentation

Running The Unit Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

  1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli
  1. Install Aurelia libs for test visibility:
jspm install aurelia-framework
jspm install aurelia-http-client
jspm install aurelia-router
  1. You can now run the tests with this command:
karma start

Running The E2E Tests

Integration tests are performed with Protractor.

  1. Place your E2E-Tests into the folder test/e2e/src
  2. Install the necessary webdriver
gulp webdriver_update
  1. Configure the path to the webdriver by opening the file protractor.conf.js and adjusting the seleniumServerJar property. Typically its only needed to adjust the version number.

  2. Make sure your app runs and is accessible

gulp watch
  1. In another console run the E2E-Tests
gulp e2e