A user experience framework with higher-level capabilities, designed to bring simplicity and elegance to building cross-device, rich experiences.
Clone or download

README.md

aurelia-ux

npm Version ZenHub Join the chat at https://gitter.im/aurelia/discuss

This library is part of the Aurelia platform and extends it by adding a higher level set of user experience-oriented features such as scoped styles, theming, components and UX patterns.

To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions look around our Discourse forums, chat in our community on Gitter or use stack overflow. Documentation can be found in our developer hub. If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards.

Documentation

Check out the showcase application for demos and documentation. If you are interested in contributing, have a read through our wiki.

Building

Before The First Build

npm install installs dependencies for the base Aurelia UX project

lerna bootstrap --hoist: sets up a symlink between all of the packages in the monorepo lerna run build: builds all of the mono repo projects.

Note: lerna run build is very CPU intensive and takes a small period of time on most machines. If you are working within a single component, you might try npm run build instead at the component level.

Tests

From the project's root directory

npm run test -- --package=name runs the tests for the specified package (defaults to -- --package=core when omitted)

lerna run test runs the tests for all packages (will start multiple chrome instances simultaneously)

From a package's own directory

npm run test runs the tests for that package

Developing

From the project's root directory

npm run develop -- --package=name runs the tests for the specified package in watch mode (defaults to -- --package=core when omitted)

From a package's own directory

npm run develop runs the tests for that package in watch mode

Online playground

  1. Go to https://gist.run/?id=f543dce545b7139e4019fd51c0bcbd4d
  2. Select Fork Gist (near top right button)
  3. Add new files and play around