⚖️ LexAI

AI-Powered Contract Intelligence Platform

Upload any legal contract. Get instant AI-powered risk analysis, clause-by-clause review, obligation tracking, and expiry alerts — all in real-time.

🎯 What It Does

Feature	Description
📄 Contract Upload	Upload PDF, DOCX, or plain text contracts
🤖 AI Analysis	Risk scoring, clause flagging, obligation extraction via OpenRouter LLM
⚡ Real-Time Updates	WebSocket notifications when analysis completes
📊 Version Comparison	AI-powered diff between contract versions
🔔 Expiry Alerts	Automated email + socket alerts before contract expiry
🏢 Multi-Tenant	Organization-based isolation with RBAC (admin/manager/viewer)
📈 Quota Management	Redis-based monthly analysis limits per subscription tier
🔐 Enterprise Security	JWT rotation, token blacklist, rate limiting, input validation

🛠️ Tech Stack

Category	Technology
Runtime	Node.js ≥ 20 (ES Modules)
Framework	Express.js 4.19
Database	MongoDB 8 + Mongoose ODM
Cache & Pub/Sub	Redis (ioredis)
Message Queue	RabbitMQ (amqplib)
Real-Time	Socket.io with Redis adapter
AI Engine	OpenRouter API (Llama 3.1, Mistral 7B)
Auth	JWT (access + refresh tokens) with bcrypt
Validation	Joi + Zod
Email	Nodemailer (SMTP)
File Parsing	pdf-parse, mammoth (DOCX)
Logging	Winston + Morgan
Security	Helmet, CORS, express-mongo-sanitize, rate limiting
Scheduling	node-cron

📁 Folder Structure

LexAI/
├── server.js              # API entry point (HTTP + Socket.io + cron)
├── worker.js              # Background worker (RabbitMQ consumers)
├── package.json           # Dependencies & scripts
├── scripts/seed.js        # First admin user seed script
│
└── src/
    ├── app.js             # Express middleware & route setup
    ├── config/            # DB, Redis, RabbitMQ, Socket.io, env validation
    ├── constants/         # HTTP codes, plans, queues, roles
    ├── models/            # 7 Mongoose models
    ├── services/          # 13 business logic services
    ├── controllers/       # 7 HTTP request handlers
    ├── middleware/         # 7 middleware (auth, RBAC, validation, rate limit)
    ├── validators/        # 4 Joi schema files
    ├── routes/            # 8 Express routers
    ├── utils/             # 8 shared utilities
    ├── sockets/           # Socket.io event bridge
    ├── workers/           # RabbitMQ consumers (analysis + alerts)
    └── jobs/              # Cron jobs (daily expiry scan)

📖 For a detailed explanation of every file and how data flows through the system, see PROJECT_GUIDE.md.

⚙️ Environment Variables

Create a .env file in the project root:

# App
NODE_ENV=development
PORT=3000
API_VERSION=v1

# MongoDB
MONGO_URI=mongodb://localhost:27017/lexai

# Redis
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=

# RabbitMQ
RABBITMQ_URL=amqp://guest:guest@localhost:5672
ANALYSIS_QUEUE=lexai.analysis.queue
ALERT_QUEUE=lexai.alert.queue
DLX_EXCHANGE=lexai.dlx

# JWT (use strong, random 32+ character strings)
JWT_ACCESS_SECRET=your-access-secret-at-least-32-chars-long
JWT_REFRESH_SECRET=your-refresh-secret-at-least-32-chars-long
JWT_ACCESS_EXPIRY=15m
JWT_REFRESH_EXPIRY=7d

# OpenRouter AI
OPENROUTER_API_KEY=sk-or-v1-your-key
OPENROUTER_BASE_URL=https://openrouter.ai/api/v1
AI_PRIMARY_MODEL=meta-llama/llama-3.1-8b-instruct:free
AI_FALLBACK_MODEL=mistralai/mistral-7b-instruct:free

# Rate Limiting
RATE_LIMIT_WINDOW_MS=60000
RATE_LIMIT_MAX=100

# File Upload
MAX_FILE_SIZE_MB=5
ALLOWED_MIME_TYPES=application/pdf,application/vnd.openxmlformats-officedocument.wordprocessingml.document,text/plain

# CORS
ALLOWED_ORIGINS=http://localhost:3000,http://localhost:5173

# Email (Ethereal for testing)
SMTP_HOST=smtp.ethereal.email
SMTP_PORT=587
SMTP_USER=
SMTP_PASS=
EMAIL_FROM=noreply@lexai.io

# External APIs
REST_COUNTRIES_URL=https://restcountries.com/v3.1
WORLD_TIME_API_URL=https://worldtimeapi.org/api

🚀 How to Run Locally

Prerequisites

Node.js ≥ 20
MongoDB (local or Atlas)
Redis (local or cloud)
RabbitMQ (local or CloudAMQP)

1. Install Dependencies

git clone https://github.com/YOUR_USERNAME/LexAI.git
cd LexAI
npm install

2. Start Infrastructure (Docker option)

If you have Docker:

docker-compose up -d    # Starts MongoDB, Redis, RabbitMQ

3. Configure Environment

cp .env.example .env    # Copy and fill in your values

4. Seed Admin User

npm run seed

5. Start the API Server

npm run dev             # Development with auto-reload
# or
npm start               # Production

6. Start the Background Worker

In a separate terminal:

npm run dev:worker      # Development
# or
npm run start:worker    # Production

7. Verify

curl http://localhost:3000/health

📡 API Endpoints

Authentication

Method	Endpoint	Auth	Description
`POST`	`/api/v1/auth/register`	❌	Register new user
`POST`	`/api/v1/auth/verify-email`	❌	Verify email token
`POST`	`/api/v1/auth/login`	❌	Login, get tokens
`POST`	`/api/v1/auth/refresh-token`	🍪	Refresh access token
`POST`	`/api/v1/auth/logout`	✅	Blacklist current token
`POST`	`/api/v1/auth/forgot-password`	❌	Request password reset
`POST`	`/api/v1/auth/reset-password`	❌	Reset with token

Users

Method	Endpoint	Auth	Description
`GET`	`/api/v1/users/me`	✅	Get my profile + quota
`PATCH`	`/api/v1/users/me`	✅	Update my name
`PATCH`	`/api/v1/users/me/password`	✅	Change password
`GET`	`/api/v1/users/:id`	🔒 Admin	Get user by ID

Organizations

Method	Endpoint	Auth	Description
`POST`	`/api/v1/orgs`	✅	Create organization
`GET`	`/api/v1/orgs/:orgId`	✅	Get org details
`PATCH`	`/api/v1/orgs/:orgId`	🔒 Admin/Mgr	Update org
`POST`	`/api/v1/orgs/:orgId/invite`	🔒 Admin/Mgr	Invite member
`POST`	`/api/v1/orgs/:orgId/invite/accept`	❌	Accept invite
`PATCH`	`/api/v1/orgs/:orgId/members/:userId/role`	🔒 Admin	Change role
`DELETE`	`/api/v1/orgs/:orgId/members/:userId`	🔒 Admin	Remove member

Contracts

Method	Endpoint	Auth	Description
`POST`	`/api/v1/contracts`	✅	Upload contract (file/text)
`GET`	`/api/v1/contracts`	✅	List with pagination/filter
`GET`	`/api/v1/contracts/:id`	✅	Get full contract
`PATCH`	`/api/v1/contracts/:id`	✅	Update metadata
`DELETE`	`/api/v1/contracts/:id`	🔒 Admin/Mgr	Soft delete
`POST`	`/api/v1/contracts/:id/versions`	✅	Upload new version
`GET`	`/api/v1/contracts/:id/versions`	✅	Version history
`POST`	`/api/v1/contracts/:id/compare`	✅	Compare versions (AI)
`GET`	`/api/v1/contracts/:id/audit`	✅	Audit trail

Analyses

Method	Endpoint	Auth	Description
`POST`	`/api/v1/analyses`	✅	Request AI analysis
`GET`	`/api/v1/analyses/:id`	✅	Get analysis result
`GET`	`/api/v1/analyses/contract/:contractId`	✅	All analyses for contract

Admin

Method	Endpoint	Auth	Description
`GET`	`/api/v1/admin/stats`	🔒 Admin	Platform statistics
`GET`	`/api/v1/admin/queue/status`	🔒 Admin	RabbitMQ queue status
`GET`	`/api/v1/admin/users`	🔒 Admin	List all users
`GET`	`/api/v1/admin/audit-logs`	🔒 Admin	Global audit logs

Health

Method	Endpoint	Auth	Description
`GET`	`/health`	❌	Service health check

📖 For complete request/response examples with dummy data, see POSTMAN_COLLECTION.md.

📊 Entity-Relationship Diagram

📖 Full ER diagram with all fields and data types is in PROJECT_GUIDE.md.

Quick overview of model relationships:

User ──belongs to──▶ Organization
Organization ──has many──▶ Contract, Invitation, AuditLog, Notification
Contract ──has many──▶ Analysis, Version (embedded), Party (embedded)
Analysis ──contains──▶ Clause (embedded)

🚢 Deployment

LexAI is deployment-ready for Render.com (free tier supported).

📖 Full step-by-step deployment guide with GitHub setup, service configuration, env vars, and common error fixes: DEPLOYMENT.md.

Live URL format after deployment:

https://lexai-api.onrender.com/health
https://lexai-api.onrender.com/api/v1/auth/login

🤝 Contributing

Fork the repository
Create a feature branch: git checkout -b feature/amazing-feature
Commit changes: git commit -m 'feat: add amazing feature'
Push to branch: git push origin feature/amazing-feature
Open a Pull Request

Commit Convention

Use Conventional Commits:

Prefix	Usage
`feat:`	New feature
`fix:`	Bug fix
`docs:`	Documentation only
`refactor:`	Code change, no feature/bug fix
`test:`	Adding/updating tests
`chore:`	Maintenance tasks

📜 License

This project is licensed under the ISC License. See LICENSE for details.

Built with ❤️ by the LexAI Team

Name		Name	Last commit message	Last commit date
Latest commit History 22 Commits
folder		folder
scripts		scripts
src		src
.dockerignore		.dockerignore
.env.example		.env.example
.gitignore		.gitignore
All_file.md		All_file.md
DEPLOYMENT.md		DEPLOYMENT.md
Dockerfile		Dockerfile
Dockerfile.worker		Dockerfile.worker
POSTMAN_COLLECTION.md		POSTMAN_COLLECTION.md
PROJECT_GUIDE.md		PROJECT_GUIDE.md
README.md		README.md
docker-compose.yml		docker-compose.yml
package-lock.json		package-lock.json
package.json		package.json
server.js		server.js
worker.js		worker.js

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

⚖️ LexAI

AI-Powered Contract Intelligence Platform

🎯 What It Does

🛠️ Tech Stack

📁 Folder Structure

⚙️ Environment Variables

🚀 How to Run Locally

Prerequisites

1. Install Dependencies

2. Start Infrastructure (Docker option)

3. Configure Environment

4. Seed Admin User

5. Start the API Server

6. Start the Background Worker

7. Verify

📡 API Endpoints

Authentication

Users

Organizations

Contracts

Analyses

Admin

Health

📊 Entity-Relationship Diagram

🚢 Deployment

🤝 Contributing

Commit Convention

📜 License

About

Uh oh!

Contributors

Uh oh!

Languages

web-dev-vishal/LexAI

Folders and files

Latest commit

History

Repository files navigation

⚖️ LexAI

AI-Powered Contract Intelligence Platform

🎯 What It Does

🛠️ Tech Stack

📁 Folder Structure

⚙️ Environment Variables

🚀 How to Run Locally

Prerequisites

1. Install Dependencies

2. Start Infrastructure (Docker option)

3. Configure Environment

4. Seed Admin User

5. Start the API Server

6. Start the Background Worker

7. Verify

📡 API Endpoints

Authentication

Users

Organizations

Contracts

Analyses

Admin

Health

📊 Entity-Relationship Diagram

🚢 Deployment

🤝 Contributing

Commit Convention

📜 License

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Contributors

Uh oh!

Languages