Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.89 KB

README.md

File metadata and controls

69 lines (45 loc) · 2.89 KB
Raw

Aurelia

License: MIT npm Version ci Discourse status Twitter Discord Chat

aurelia-validation

This library is part of the Aurelia platform and contains a plugin that provides validation capabilities.

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 Discord or use stack overflow. Documentation can be found in our developer hub.

Documentation

Check out the docs on the Aurelia Hub.

Reporting Issues

Please refer to the issue template. Accompany any bug report with a demo of the issue using a runnable Gist.

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. To build the code, you can now run:
npm run build
  1. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

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. You can now run the tests with this command:
npm run test

You can optionally run either of the following:

npm run test:watch
# OR
npm run test:debugger

to have better development experience, with watch/debuging capabilities

Publishing

Refer to ./doc/MAINTAINER.md for details.