Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.37 KB

README.md

File metadata and controls

66 lines (43 loc) · 2.37 KB
Raw

aurelia-router

npm Version 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.

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. Run the test script:
npm run test
  1. With watch options to rerun the test (headless):
npm run test:watch
  1. With watch options to rerun the test (with browser):
npm run test:debugger