apfm-rules-engine v1.0.0

AFPM Rules Engine

This is repository for APFM Rules Engine project. This project is for 2 purposes:

1. REST API service - deployable REST service which is used to create, read, update and delete rules for specific lead form.
2. NPM package - installable npm package which can be used in any APFM project which contains lead forms and chaining features. In order to avoid making HTTP requests, special functions are exposed which will directly check if the rules for lead form with specific slug are satisfied according to the users answers.

Run app locally

You can run this app locally with:

npm install
npm run start

Testing

Tests are a work in progress. Tests may be added in the tests directory closest to the related file. Run:

npm run test

Contributing

1. Clone the repository: git clone https://github.com/aplaceformom/apfm-rules-engine.git
2. Install the dependencies: npm install
3. Create a new branch: git checkout -b my-feature-branch
4. Develop changes locally: npm run start
5. Commit and push to your branch: git push -u origin HEAD
6. Go to the repository and make a Pull Request. Pull requests require a minimum of one approval and passing CI checks.