https://github.com/niieani/aurelia-cycle-example
An example for the aurelia-cycle plugin
https://github.com/niieani/aurelia-cycle-example
Last synced: 3 months ago
JSON representation
An example for the aurelia-cycle plugin
- Host: GitHub
- URL: https://github.com/niieani/aurelia-cycle-example
- Owner: niieani
- Created: 2016-03-03T00:48:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T08:50:35.000Z (almost 2 years ago)
- Last Synced: 2025-07-11T13:43:36.784Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 110 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# aurelia-cycle-example
This is an example for the [aurelia-cycle](http://github.com/niieani/aurelia-cycle) plugin for the [Aurelia platform](http://aurelia.io).
## Running The App
To run the app, follow these steps.
1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:
```shell
npm install
```
3. Ensure that [Gulp](http://gulpjs.com/) is installed globally. If you need to install it, use the following command:
```shell
npm install -g gulp
```
> **Note:** Gulp must be installed globally, but a local version will also be installed to ensure a compatible version is used for the project.
4. Ensure that [jspm](http://jspm.io/) is installed globally. If you need to install it, use the following command:
```shell
npm install -g jspm
```
> **Note:** jspm must be installed globally, but a local version will also be installed to ensure a compatible version is used for the project.
> **Note:** Sometimes jspm queries GitHub to install packages, but GitHub has a rate limit on anonymous API requests. If you receive a rate limit error, you need to configure jspm with your GitHub credentials. You can do this by executing `jspm registry config github` and following the prompts. If you choose to authorize jspm by an access token instead of giving your password (see GitHub `Settings > Personal Access Tokens`), `public_repo` access for the token is required.
5. Install the client-side dependencies with jspm:
```shell
jspm install -y
```
>**Note:** Windows users, if you experience an error of "unknown command unzip" you can solve this problem by doing `npm install -g unzip` and then re-running `jspm install`.
6. Build the project:
```shell
gulp build
```
7. To run the app, execute the following command:
```shell
gulp watch
```
8. Browse to [http://localhost:9000](http://localhost:9000) to see the app. You can make changes in the code found under `src` and the browser should auto-refresh itself as you save files.
> The Skeleton App uses [BrowserSync](http://www.browsersync.io/) for automated page refreshes on code/markup changes concurrently accross multiple browsers. If you prefer to disable the mirroring feature set the [ghostMode option](http://www.browsersync.io/docs/options/#option-ghostMode) to false.