This is a Yeoman Generator for the Skeleton App of the Aurelia platform. It sets up a standard navigation-style app using gulp to build your ES6 code with the 6to5 compiler. Karma/Jasmine testing is also configured.
For more info please visit the official site: http://www.aurelia.io/
- Verify that Yeoman is installed
npm install -g yo
- Install this generator
npm install -g generator-aurelia
- Create a new project folder and move into it in the terminal
mkdir YOUR_PROJECT_NAME
cd YOUR_PROJECT_NAME
- Execute the following command
yo aurelia
- Install the apps NodeJS dependencies
npm install
- Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
- Ensure that jspm is installed. If you need to install it, use the following command:
npm install -g jspm
Note: jspm queries GitHub to install semver packages, but GitHub has a rate limit on anonymous API requests. It is advised that you configure jspm with your GitHub credentials in order to avoid problems. You can do this by executing
jspm endpoint config github
and following the prompts.
- Install the client-side dependencies with jspm:
jspm install
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-runningjspm install
.
- To run the app, execute the following command:
gulp watch
- Browse to 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.
In order to create a new Aurelia Page just enter the following command inside your project root:
yo aurelia:page YOURPAGENAME
If you get an error like
Error: spawn git ENOENT
when executing the yo command, you should check whether GIT is installed and accessible from the command line
This will create a View and ViewModel with the given name inside the ./src
folder
Thanks to Addy Osmani for his awesome generator-boilerplate repo.