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.
To run the app, follow these steps.
From the project folder, execute the following command:
npm install
Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
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.
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-runningjspm install
.
To run the app, execute the following command:
gulp watch
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="https://github.com/plwalters/staurelia-wars/raw/master/jspm_packages/github/webcomponents/webcomponentsjs@0.5.2/HTMLImports.js"></script>
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:
Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli
jspm install aurelia-framework
jspm install aurelia-http-client
jspm install aurelia-router
You can now run the tests with this command:
karma start
Integration tests are performed with Protractor.
Place your E2E-Tests into the folder test/e2e/src
Install the necessary webdriver
gulp webdriver_update
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.
Make sure your app runs and is accessible
gulp watch
In another console run the E2E-Tests
gulp e2e