The aurelia framework brings together all the required core aurelia libraries into a ready-to-go application-building platform.
Clone or download
EisenbergEffect doc(backers): a new Bronze Backer
Thanks CodeFirst for your generation contribution to Aurelia!
Latest commit 01c0272 Nov 17, 2018
Permalink
Failed to load latest commit information.
build chore(build): update conventional change log config Jun 20, 2016
dist doc(backers): a new Bronze Backer Nov 17, 2018
doc doc(all): move images to documentation repo Nov 8, 2018
src fix(FrameworkConfiguration): use private info Jun 21, 2018
test feat(Aurelia): ability to define root with constructor May 31, 2018
.editorconfig chore(*): set up the project structure and build Dec 10, 2014
.eslintrc.json chore(eslint): update to eslint 2 May 18, 2016
.gitignore chore: add task 'cover' to run tests with code coverage Jun 5, 2015
.npmignore chore(*): set up the project structure and build Dec 10, 2014
BACKERS.md doc(backers): a new Bronze Backer Nov 17, 2018
CONTRIBUTING.md chore(all): new build, contrib and lint Feb 6, 2015
ISSUE_TEMPLATE.md doc(issue_template): update issue template Apr 4, 2017
LICENSE chore(LICENSE): update dates Jan 1, 2018
README.md There should be Documentation instead of documention May 14, 2018
bower.json chore(all): prepare release 1.3.0 Jul 2, 2018
circle.yml chore(all): update bulid, lint, deps, d.ts gen and docs gen Jun 15, 2016
config.js feat(config): accepts classes beside module id string May 14, 2018
gulpfile.js chore(all): new build, contrib and lint Feb 6, 2015
karma.conf.js chore(all): update to Babel 6 (ongoing) Mar 15, 2016
package.json chore(package): add module field Oct 13, 2018
tsconfig.json chore(all): update bulid, lint, deps, d.ts gen and docs gen Jun 15, 2016
typings.json chore(all): prepare release 1.0.0-beta.2.0.1 Jun 16, 2016

README.md

aurelia-framework

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

This library is part of the Aurelia platform and contains the aurelia framework which brings together all the required core aurelia libraries into a ready-to-go application-building platform.

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.

Documentation

You can read the documentation for the aurelia framework here. If you would like to help improve this documentation, the source for many of the docs can be found in the doc folder within this repository. Other docs, not related to the general framework, but directed at specific libraries, can be found in the doc folder of those libraries.

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. 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 command:
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