Rule-Engine-With-AST

A simple 3-tier rule engine application(Simple UI, API and Backend, Data) to determine user eligibility based on attributes like age, department, income, spend etc.The system uses Abstract Syntax Tree (AST) to represent conditional rules and allow for dynamic creation,combination, and modification of these rules.

Table of Contents

• Features
• Technologies Used
• Setup
  • Prerequisites
  • Clone the Repository
  • Install Dependencies
  • Environment Variables
  • Start the Backend Server
  • Start the Frontend Application
• Usage
• API Endpoints
• How to Use

Features

• Fetch and display rules from the server.
• Select multiple rules for combining.
• Evaluate selected rules against user data.
• Dynamic user input for age, department, salary, and experience.
• User-friendly UI with loading indicators and error handling.

Technologies Used

• Frontend: React, Axios
• Backend: Node.js, Express.js
• Database: MongoDB
• Development Tools: Git, npm

Setup

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (version 14 or above)
• npm (Node Package Manager, usually comes with Node.js)
• MongoDB (for database management)

Clone the Repository

1. Open your terminal.

2. Clone the repository using the following command:

   git clone https://github.com/Gayatrisin123/Rule-Engine.git
   

   cd rule-engine
   

Install Dependencies

1. Navigate to the backend folder:

 cd server

Install the necessary backend packages:

 npm install

2. Navigate to the frontend folder:

 cd client

Install the necessary frontend packages:

 npm install

Environment Variables

Create a .env file in the backend directory.

Add the following environment variables to the .env file:

PORT=5000 MONGODB_URI=

Replace with your actual MongoDB connection string.

Start the Backend Server

Navigate back to the backend directory if not already there:

cd backend

Start the backend server:

npm start  or npm run dev

The backend server will run on http://localhost:5000.

Start the Frontend Application

open a new terminal window and navigate to the frontend directory:

 cd frontend

Start the frontend React application:

npm start

The frontend will run on http://localhost:3000.

Usage

Open your browser and navigate to http://localhost:3000.

You will see a list of rules fetched from the backend.

Select the rules you want to combine and evaluate.

Input user data in the provided fields (age, department, salary, experience).

Click "Evaluate" to check if the user data meets the criteria of the selected rule(s).

Click "Combine Selected Rules" to combine your selections.

API Endpoints

Fetch All Rules: GET /api/rules

Combine Selected Rules: POST /api/rules/combine

Evaluate a Rule: POST /api/rules/evaluate

Refer to the API documentation for more details on each endpoint.

How to use

create a rule by enterinh any rule inside the create rule inbox

now click on create rule

now a alert will be pop up

copy the rule id for future reference

now the evaluation part

if you have rule id then write it in the rule id section

and fill all other details

and click on evaluate

---