aurelia-mdl-skeleton-navigation

Material Design Lite

This is a fork of aurelia-skeleton-navigation, using Material Design Lite for layout. It serves as a playground to develop/test mdl custom elements.

skeleton-navigation

This skeleton is part of the Aurelia platform. It sets up a standard navigation-style app using gulp to build your ES6 code with the Babel compiler. Karma/Protractor/Jasmine testing is also configured.

To keep up to date on Aurelia, please visit and subscribe to the official blog. If you have questions, we invite you to join us on Gitter. If you would like to have deeper insight into our development process, please install the ZenHub Chrome Extension and visit any of our repository's boards. You can get an overview of all Aurelia work by visiting the framework board.

Running The App

To run the app, 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

3. Ensure that Gulp is installed. If you need to install it, use the following command:

npm install -g gulp

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

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. To run the app, execute the following command:

gulp watch

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

The Skeleton App uses BrowserSync for automated page refreshes on code/markup changes concurrently accross multiple browsers. If you prefer to disable the mirroring feature set the ghostMode option to false

Note: At present there is a bug in the HTMLImports polyfill which only occurs on IE. We have submitted a pull request to the team with the fix. In the mean time, if you want to test on IE, you can work around the issue by explicitly adding a script tag before you load system.js. The script tag should look something like this (be sure to confirm the version number):

<script src="jspm_packages/github/webcomponents/webcomponentsjs@0.5.2/HTMLImports.js"></script>

Running The App under Electron

To run the app under Electron, follow these steps.

1. Install Electron

npm install electron-prebuilt -g

2. To start the app, execute the following command:

electron .

Bundling

Bundling is performed by Aurelia Bundler. A gulp task is already configured for that. Use the following command to bundle the app:

  gulp bundle

You can also unbundle using the command bellow:

gulp unbundle

Running The Unit 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

2. Install Aurelia libs for test visibility:

jspm install aurelia-framework
jspm install aurelia-http-client
jspm install aurelia-router

3. You can now run the tests with this command:

karma start

Running The E2E Tests

Integration tests are performed with Protractor.

1. Place your E2E-Tests into the folder test/e2e/src
2. Install the necessary webdriver

gulp webdriver_update

3. 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.

4. Make sure your app runs and is accessible

gulp watch

5. In another console run the E2E-Tests

gulp e2e