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.
Check out the showcase application for demos and documentation. If you are interested in contributing, have a read through our wiki. You can view an online demo here, https://aux-demo.web.app.
Before The First Build
npm ci
: installs dependencies for the base Aurelia UX project
npm run bootstrap
: sets up a symlink between all of the packages in the monorepo
npm run build
: builds all of the mono repo projects.
Note:
npm 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 trynpm run build
instead at the component package level.
npm run test -- --package=name
runs the tests for the specified package (defaults to -- --package=core
when omitted)
If you have lerna
installed globally:
lerna run test
runs the tests for all packages (will start multiple chrome instances simultaneously)
npm run test
runs the tests for that package
- Production build:
npm run build
- Dev build:
npm run build:dev
# or for watch
npm run build:dev:watch
If you want to build to a specific, non default, folder, do:
npm run build -- --environment target_dir: path/to/my/dir
# or
npm run build:dev -- --environment target_dir: path/to/my/dir
# or
npm run build:dev:watch -- --environment target_dir: path/to/my/dir
To run the test app, first make sure you built all the packages via the instruction of how to build above. Then open a shell at root of this project and copy paste the following:
cd app
npm ci
npm run dev
To run the test app, with all dependencies pointing to the packages source code, first make sure you could run in previous step, then do:
- Uncomment line 33 to line 65 in webpack.config.js in
app
folder - Open a shell at root of this project and run:
cd app
npm ci
npm run dev
This will use webpack-dev-server
and webpack
to alias all ux
dependencies to the source in pakcages
folder.
npm run develop -- --package=name
runs the tests for the specified package in watch
mode (defaults to -- --package=core
when omitted)
npm run develop
runs the tests for that package in watch
mode
- Go to https://gist.run/?id=f543dce545b7139e4019fd51c0bcbd4d
- Select Fork Gist (near top right button)
- Add new files and play around