Aurelia single state store based on RxJS
Switch branches/tags
Nothing to show
Clone or download

README.md

aurelia-store

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

This library is part of the Aurelia platform and contains a plugin that provides a single state store based on RxJS. Various examples can be found in the samples repository..

You can find complete documentation on setup and usage in the official Aurelia Developer Hub

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.

Dependencies

  • RxJS v6
  • aurelia-dependency-injection
  • aurelia-framework
  • aurelia-logging
  • aurelia-pal

Platform Support

This library can be used in the browser and node.

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 various module formats.

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. For single execution run:
npm run test
  1. For continuous tdd style:
npm run test-watch
  1. You can find the coverage report built after each test run:
cat /test/coverage-jest/index.html