A powerful client-side router.
davismj Merge pull request #623 from davismj/build/typescript
refactor: Convert to TypeScript
Latest commit 531eff1 Oct 18, 2018
Permalink
Failed to load latest commit information.
.circleci chore(ci): upgrade to circleci 2.0 Sep 2, 2018
.vscode fix typings error, add lint, changelog tasks Aug 19, 2018
build Merge branch 'master' into ts-router Oct 15, 2018
dist chore(all): prepare release 1.6.3 Sep 27, 2018
doc doc(router-configuration): Grammatical fix Oct 16, 2018
src build(pipeline-provider): Improve PipelineProvider types Oct 18, 2018
test fix(app-router.spec): Change RoutingComponent to ViewPortComponent Oct 18, 2018
.editorconfig chore(*): set up the project structure and build Dec 10, 2014
.gitignore refactor(all): Convert to TS Aug 19, 2018
.npmignore chore(*): set up the project structure and build Dec 10, 2014
CONTRIBUTING.md chore(all): new build, contrib and lint Feb 6, 2015
ISSUE_TEMPLATE.md chore(issue_template): fix company and email Sep 22, 2016
LICENSE chore(LICENSE): update dates Jan 1, 2018
README.md build(package): Add npm start command Oct 18, 2018
bower.json chore(all): prepare release 1.6.3 Sep 27, 2018
config.js chore(config): update deps Jul 17, 2018
gulpfile.js chore(all): new build, contrib and lint Feb 6, 2015
karma.conf.js remove transpileOnly in test Aug 19, 2018
package-lock.json chore(all): update dependencies, build Oct 15, 2018
package.json build(package): Add npm start command Oct 18, 2018
tsconfig.json turn on strict flags, split ViewPortInstruction interface, fix code s… Aug 19, 2018
tslint.json fix typings error, add lint, changelog tasks Aug 19, 2018
typings.json chore(all): prepare release 1.0.0-beta.2.0.1 Jun 17, 2016

README.md

aurelia-router

npm Version ZenHub Join the chat at https://gitter.im/aurelia/discuss CircleCI

This library is part of the Aurelia platform and contains a powerful client-side router. @davismj is currently the technical lead for routing.

To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions look around our Discourse forums, chat in our community on Gitter or use stack overflow. Documentation can be found in our developer hub. If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards.

Platform Support

This library can be used in the browser only.

Building The Code

To build the code, 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. To build the code, you can now run:
npm run build
  1. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

Development

  1. To run the project in development mode, you can run:
npm start
  1. If you want to copy over the newly built bundle, you can specified --target:
npm start -- --target ..\my-test-project

Running The 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. Ensure that jspm is installed. If you need to install it, use the following commnand:
npm install -g jspm
  1. Install the client-side dependencies with jspm:
jspm install
  1. You can now run the tests with this command:
karma start