aurelia / templating-router

An implementation of the RouteLoader interface for use with the router module. Also contains a custom element that allows the templating engine to display the current route.
MIT License
26 stars 40 forks source link

Aurelia

License: MIT npm Version ci Discourse status Twitter Discord Chat

aurelia-templating-router

This library is part of the Aurelia platform and contains an implementation of the RouteLoader interface for use with the router module. It also contains a custom element that allows the templating engine to display the current route.

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 Discord 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
  3. To build the code, you can now run:

    npm run build
  4. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

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 run test
  2. With watch options to rerun the test (headless):

    npm run test:watch
  3. With watch options to rerun the test (with browser):

    npm run test:debugger