To run the app, follow these steps.
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 is installed globally. If you need to install it, use the following command:
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: 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 registry config githuband 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_repoaccess for the token is required. 5. Install the client-side dependencies with jspm:
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 unzipand then re-running
jspm install. 6. To run the app, execute the following command:
srcand the browser should auto-refresh itself as you save files.
The Skeleton App uses BrowserSync for automated page refreshes on code/markup changes concurrently across multiple browsers. If you prefer to disable the mirroring feature set the ghostMode option to false
To run the app under Electron, follow these steps.
npm install electron-prebuilt -g
Note: If you use electron every time or are packaging and so-forth, Then change this line in package.json from
"main": "index.js",Build the app (this will give you a dist directory)
To start the app, execute the following command:
Bundling is performed by Aurelia Bundler. A gulp task is already configured for that. Use the following command to bundle the app:
You can also unbundle using the command bellow:
To start the bundled app, execute the following command:
The configuration is done by
rev: true to add bundle file revision/version.
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:
npm install -g karma-cli
jspm install aurelia-frameworkjspm install aurelia-http-clientjspm install aurelia-router
Integration tests are performed with Protractor.
Configure the path to the webdriver by opening the file
protractor.conf.js and adjusting the
seleniumServerJar property. Typically its only needed to adjust the version number.
Make sure your app runs and is accessible
A gulp task is already configured for that. Use the following command to export the app:
The app will be exported into
export directory preserving the directory structure.
The configuration is done by
export.js file is available for including individual files.