Skip to content
A notification plugin for Aurelia.
JavaScript Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
build
dist chore(*): prepare release 0.8.1 May 16, 2017
doc chore(*): prepare release 0.8.1 May 16, 2017
sample
src fix(controller): return deactivation lifecycle promise May 16, 2017
test/unit test(*): simplify framework configuration fixture May 7, 2017
.editorconfig chore(all): setup repo structure Nov 24, 2015
.eslintrc.json
.gitignore chore(all): setup repo structure Nov 24, 2015
.npmignore chore(all): setup repo structure Nov 24, 2015
.travis.yml
LICENSE chore(*): update copyright May 6, 2017
README.md
bower.json
config.js
gulpfile.js chore(all): setup repo structure Nov 24, 2015
karma.conf.js
package-lock.json
package.json
tsconfig.json chore(*): update build processes Jun 27, 2016
typings.json
yarn.lock

README.md

aurelia-notify

Build Status Coverage Status Dependency Status devDependency Status npm Version

A simple notification plugin for Aurelia.

notification.info('A simple info notification');

Documentation

Dependencies

This plugin has no external library dependencies and is completely based on Aurelia.

Aurelia dependencies:

Used By

This library is an optional plugin and not used by the core framework.

Platform Support

This library can be used in the browser.

Building The Code

To build the code, 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
  1. Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
  1. To build the code, you can now run:
gulp build
  1. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

  2. See gulpfile.js for other tasks related to generating the docs and linting.

Running The 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
  1. Ensure that jspm is installed. If you need to install it, use the following commnand:
npm install -g jspm
  1. Install the client-side dependencies with jspm:
jspm install
  1. Ensure that you have Chrome installed. Karma runs the test suite in Chrome.

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

karma start

Running The Sample

To run the sample code using this plugin proceed with these additional steps:

  1. Go to the sample directory and install dependencies using jspm:
cd sample
jspm install
  1. Go back to the root of the project and use gulp to serve the sample project:
cd ..
gulp watch
You can’t perform that action at this time.