Skip to content

Gov-10/capstone-proj

πŸ“¦ README.md - Legal Summarizer Documentation

THE LIVE PREVIEW OF THIS PROJECT IS CURRENTLY DOWN DUE TO CLOUD PROVIDER ACCOUNT ISSUES, SORRY FOR THE INCONVENIENCE CAUSED

Project Overview

Legal Summarizer is an AI-powered platform designed to simplify complex legal documents for startups and entrepreneurs. Using advanced natural language processing and machine learning, it automatically summarizes lengthy legal contracts, terms of service, and regulatory documents into clear, actionable insights.


✨ Key Features

πŸ€– AI-Powered Summarization

  • Intelligent document parsing and analysis
  • Automatic extraction of key clauses and obligations
  • Multi-language support for international documents
  • Real-time processing for quick results

πŸ“Š Smart Analysis

  • Risk assessment and alerts
  • Clause categorization and highlighting
  • Comparison with standard templates
  • Key terms identification and explanation

πŸ‘₯ User-Friendly Interface

  • Clean, intuitive web interface
  • Mobile-responsive design
  • Document upload and management
  • Saved summaries and history

πŸ”’ Security & Privacy

  • End-to-end encryption
  • Secure document storage
  • GDPR compliant
  • No data sharing with third parties

🎯 Use Cases

  • Startups: Review investor agreements and contracts
  • Entrepreneurs: Understand NDAs and service agreements
  • Teams: Collaborate on document analysis
  • Legal Professionals: Automate preliminary document review
  • Enterprises: Process bulk legal documents

πŸš€ Quick Start

Prerequisites

- Node.js 16+ or Python 3.8+
- Git
- Database (PostgreSQL/MySQL)
- API keys (NLP service if applicable)

Installation

Option 1: Using Docker

git clone https://github.com/Nimmanagotitharunkumarhello/Legal-Summarizer.git
cd Legal-Summarizer
docker-compose up --build

Option 2: Manual Setup

Backend (FastAPI/Django):

cd fastapi_agents
pip install -r requirements.txt
python main.py

Frontend (React/Next.js):

cd front
npm install
npm run dev

First Steps

  1. Navigate to http://localhost:3000
  2. Create an account
  3. Upload a legal document
  4. View the AI-generated summary
  5. Explore key findings and recommendations

Environment Variables

This project requires specific environment variables for local development.
Contributors should create a .env file in the root of the project and use the following as a reference:

### Django Ninja Backend

NEON_PASSWORD=your_neon_password_here
NEON_HOST=your_neon_host_here
COGNITO_REGION=your_cognito_region_here
AWS_ACCESS_KEY_ID=your_aws_access_key_id_here
AWS_SECRET_ACCESS_KEY=your_aws_secret_access_key_here
S3_BUCKET_NAME=your_s3_bucket_name_here
USER_POOL_ID=your_user_pool_id_here
USER_CLIENT_ID=your_user_client_id_here

# FastAPI Backend

REDIS_URL=your_redis_url_here
REDIS_PORT=your_redis_port_here
REDIS_PASSWORD=your_redis_password_here
SUBSCRIBER_PATH=your_subscriber_path_here

Notes:

  • Replace placeholder values (your_…_here) with your actual credentials locally.
  • Do not commit your real .env file to the repository.
  • Use this as a sample configuration reference for contributors.

πŸ“š Documentation


πŸ—οΈ Project Structure

Legal-Summarizer/
β”œβ”€β”€ fastapi_agents/          # Backend API services
β”‚   β”œβ”€β”€ main.py
β”‚   β”œβ”€β”€ requirements.txt
β”‚   └── services/
β”œβ”€β”€ django_back/             # Alternative Django backend
β”œβ”€β”€ front/                   # React/Next.js frontend
β”‚   β”œβ”€β”€ components/
β”‚   β”œβ”€β”€ pages/
β”‚   └── public/
β”œβ”€β”€ docs/                    # Documentation
β”œβ”€β”€ docker-compose.yml       # Docker configuration
└── README.md               # This file

πŸ”§ Technology Stack

Backend

  • FastAPI / Django - Web framework
  • Python - Core language
  • PostgreSQL/MySQL - Database
  • Hugging Face/OpenAI - NLP models

Frontend

  • React / Next.js - UI framework
  • Tailwind CSS - Styling
  • TypeScript - Type safety

DevOps

  • Docker - Containerization
  • Docker Compose - Orchestration
  • GitHub Actions - CI/CD

πŸ“Š API Endpoints

Authentication

POST /api/auth/register     - Create account
POST /api/auth/login        - User login
POST /api/auth/logout       - User logout
POST /api/auth/refresh      - Refresh token

Documents

POST /api/documents/upload  - Upload document
GET /api/documents          - List documents
GET /api/documents/{id}     - Get document details
DELETE /api/documents/{id}  - Delete document

Summarization

POST /api/summarize         - Generate summary
GET /api/summaries/{id}     - Get summary
PUT /api/summaries/{id}     - Update summary
DELETE /api/summaries/{id}  - Delete summary

πŸ§ͺ Testing

# Run tests
pytest tests/                    # Backend tests
npm test                         # Frontend tests

# Run with coverage
pytest --cov=services tests/

# Run specific test
pytest tests/test_summarizer.py

πŸ› Known Issues

  • Large PDFs (>50MB) may take longer to process
  • Some complex legal jargon may need manual review
  • Multi-column layouts require preprocessing

πŸ“ Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Quick steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit changes (git commit -m 'Add amazing feature')
  4. Push to branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


🀝 Support


🎯 Roadmap

v1.1 (Q1 2026)

  • Multi-language support
  • Advanced filtering options
  • Batch processing

v1.2 (Q2 2026)

  • AI-powered recommendations
  • Integration with document management systems
  • Enhanced security features

v2.0 (Q3 2026)

  • Blockchain verification
  • Advanced analytics dashboard
  • Mobile app release

πŸ‘₯ Authors


πŸ™ Acknowledgments

  • Built with ❀️ for the startup community
  • Powered by cutting-edge AI technology
  • Thanks to all contributors and supporters

Made with ❀️ by Govind S

Star on GitHub ⭐ | Follow on LinkedIn πŸ‘₯

About

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors