A starter kit for building an Aurelia plugin.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build chore(build): remove deprecated babel-preset-es2015-loose and update … Mar 17, 2017
dist chore(all): update build Jul 27, 2016
doc
src switched jshint to jslint Nov 1, 2015
test chore(all): added setup.js, updated karma.conf.js and updated core.js… Mar 10, 2016
.editorconfig feat(all): initial commit of skeleton Mar 23, 2015
.eslintrc.json fix(eslintrc): correct file extension Jul 5, 2016
.gitignore chore(build): update babel and add code coverage task Jun 8, 2015
.npmignore feat(all): initial commit of skeleton Mar 23, 2015
CONTRIBUTING.md feat(all): initial commit of skeleton Mar 23, 2015
ISSUE_TEMPLATE.md chore(issue_template): fix company and email Sep 22, 2016
LICENSE
README.md doc(readme): standard info block update Sep 7, 2016
config.js chore(all): update jspm config Jul 27, 2016
gulpfile.js feat(all): initial commit of skeleton Mar 23, 2015
karma.conf.js
package.json chore(build): remove deprecated babel-preset-es2015-loose and update … Mar 17, 2017

README.md

aurelia-skeleton-plugin

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

This skeleton is part of the Aurelia platform. It sets up a standard aurelia plugin using gulp to build your ES6 code with the Babel compiler. 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
  1. Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
  1. To build the code, you can now run:
gulp build
  1. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

  2. See gulpfile.js for other tasks related to generating the docs and linting.

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