Skip to content

Latest commit

 

History

History
111 lines (65 loc) · 2.52 KB

README.md

File metadata and controls

111 lines (65 loc) · 2.52 KB
Raw

Rules Engine PoC

Description

This project serves as a proof of concept (PoC) for implementing rules engines in Node.js. It utilizes two different rules engines: @gorules/zen-engine and json-rules-engine.

Installation

Before running the project, make sure you have Node.js and npm installed on your machine. Then, follow these steps:

  1. Clone this repository to your local machine.
  2. Navigate to the project directory.
  3. Run npm install to install the project dependencies.

Usage

Building the Project

To build the project, you can use the following command:

npm run build

This command will compile TypeScript files to JavaScript files using tsc with the --watch flag to continuously watch for changes.

Running the Engine Demos

This project includes two demo scripts for each rules engine:

  • zen-demo.js for the @gorules/zen-engine
  • jre-demo.js for the json-rules-engine

You can start each demo using the following commands:

npm run start:zen-engine
npm run start:json-rules-engine

Zen Engine Demo

To start the Zen Engine demo, run the following command:

npm run start:zen-engine

Example output:

{ performance: '928.25µs', result: { scanning: { interval: 120000 } } }

JSON Rules Engine Demo

To start the JSON Rules Engine demo, run the following command:

npm run start:json-rules-engine

Example output:

scanning interval:  30000
performance: 1.382125000000002 ms

Please note that in these demonstrations, the start date is randomly generated to be in the future, specifically from the current time onwards (NOW or later).

View and amend the rulesets of the engines.

Zen Engine

Upload the JDM file rulesets/blackwidow-jdm.json into the ZEN Editor in order to visualize & update it: https://editor.gorules.io/

JSON Rules Engine

Manualy change the ruleset file: rulesets/blackwidow-jre.json

Project Structure

  • src/: Contains TypeScript source files.
  • dist/: Output directory for compiled JavaScript files.

Dependencies

This project relies on the following dependencies:

Development Dependencies

  • typescript: TypeScript compiler for compiling TypeScript code.
  • @types/node: TypeScript type definitions for Node.js.

Production Dependencies

  • @gorules/zen-engine: Zen engine for implementing business rules.
  • json-rules-engine: JSON Rules Engine for defining and executing rules.

License

This project is licensed under the ISC License.

Author

Yair Nevet