manuel-guilbault/aurelia-skeleton-plugin-typescript

aurelia-skeleton-plugin-typescript

This skeleton is part of the Aurelia platform. It sets up a standard aurelia plugin using TypeScript. Karma/Jasmine testing is also configured.

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, please join 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.

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 five module formats: AMD, CommonJS, ES2015, ES2017 and System.

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

2. You can now run the tests with this command:

npm test

Alternatively, you can run the tests in watch mode with this command:

npm run develop

Installing the plugin

In a CLI-based app

{
  "name": "aurelia-skeleton-plugin-typescript",
  "path": "../node_modules/aurelia-skeleton-plugin-typescript/dist/amd",
  "main": "index",
  "resources": ["**/*.{css,html}"]
}