| 1 | # aurelia-bootstrapper
|
| 2 |
|
| 3 | [](https://www.npmjs.com/package/aurelia-bootstrapper)
|
| 4 | [](https://zenhub.io)
|
| 5 | [](https://gitter.im/aurelia/discuss?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 6 | [](https://circleci.com/gh/aurelia/bootstrapper)
|
| 7 |
|
| 8 | This library is part of the [Aurelia](http://www.aurelia.io/) platform and contains the bootstrapper which sets up the default configuration for the aurelia framework and gets you up and running quick and easy.
|
| 9 |
|
| 10 | > To keep up to date on [Aurelia](http://www.aurelia.io/), please visit and subscribe to [the official blog](http://blog.aurelia.io/) and [our email list](http://eepurl.com/ces50j). We also invite you to [follow us on twitter](https://twitter.com/aureliaeffect). If you have questions, please [join our community on Gitter](https://gitter.im/aurelia/discuss) or use [stack overflow](http://stackoverflow.com/search?q=aurelia). Documentation can be found [in our developer hub](http://aurelia.io/hub.html). If you would like to have deeper insight into our development process, please install the [ZenHub](https://zenhub.io) Chrome or Firefox Extension and visit any of our repository's boards.
|
| 11 |
|
| 12 | ## Platform Support
|
| 13 |
|
| 14 | This library can be used in the **browser** only.
|
| 15 |
|
| 16 | ## Building The Code
|
| 17 |
|
| 18 | To build the code, follow these steps.
|
| 19 |
|
| 20 | 1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
|
| 21 | 2. From the project folder, execute the following command:
|
| 22 |
|
| 23 | ```shell
|
| 24 | npm install
|
| 25 | ```
|
| 26 | 3. Ensure that [Gulp](http://gulpjs.com/) is installed. If you need to install it, use the following commands:
|
| 27 |
|
| 28 | ```shell
|
| 29 | npm install -g gulp
|
| 30 | npm install -g gulp-cli
|
| 31 | ```
|
| 32 | 4. To build the code, you can now run:
|
| 33 |
|
| 34 | ```shell
|
| 35 | gulp build
|
| 36 | ```
|
| 37 | 5. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.
|
| 38 |
|
| 39 | 6. See `gulpfile.js` for other tasks related to generating the docs and linting.
|
| 40 |
|
| 41 | ## Running The Tests
|
| 42 |
|
| 43 | 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:
|
| 44 |
|
| 45 | 1. Ensure that the [Karma](http://karma-runner.github.io/) CLI is installed. If you need to install it, use the following command:
|
| 46 |
|
| 47 | ```shell
|
| 48 | npm install -g karma-cli
|
| 49 | ```
|
| 50 | 2. Ensure that [jspm](http://jspm.io/) is installed. If you need to install it, use the following commnand:
|
| 51 |
|
| 52 | ```shell
|
| 53 | npm install -g jspm
|
| 54 | ```
|
| 55 | 3. Install the client-side dependencies with jspm:
|
| 56 |
|
| 57 | ```shell
|
| 58 | jspm install
|
| 59 | ```
|
| 60 |
|
| 61 | 4. You can now run the tests with this command:
|
| 62 |
|
| 63 | ```shell
|
| 64 | karma start
|
| 65 | ```
|
| 66 | |
| \ | No newline at end of file |