📄 PaiperSum - Legal Document Simplifier

AI-powered legal document analysis that translates complex contracts into plain English with risk assessments.

PaiperSum is a production-ready SaaS platform that helps individuals and businesses understand legal documents by automatically identifying risks, highlighting important clauses, and providing plain-English summaries.

✨ Features

Core Capabilities

🔍 Automated Analysis - Instant risk assessment of legal documents
📊 Risk Scoring - 0-100 risk score with confidence metrics
🎯 Clause Detection - Identifies 14+ types of important clauses
📝 Plain English - Complex legalese translated into readable summaries
📄 PDF Export - Professional reports with citations
🔌 Browser Extension - Analyze any webpage instantly
📱 Responsive UI - Beautiful, accessible interface

Document Types Supported

Terms of Service / EULA
Privacy Policies
Contracts & Agreements
Waivers & Releases
NDAs & Confidentiality Agreements
Employment Agreements
Rental/Lease Agreements

Detected Clauses

❗ High Risk (Red): Indemnification, Liability Waivers, Assumption of Risk
⚠️ Moderate Risk (Yellow): Arbitration, Class Action Waivers, Auto-Renewal, Data Sharing
✅ Low Risk (Green): Governing Law, Termination, Force Majeure

🚀 Quick Start

Prerequisites

Node.js 20+ (Download)
Python 3.10+ (Download)
Docker (optional, for containerized deployment)

Installation

# 1. Clone the repository
git clone https://github.com/yourusername/paipersum.git
cd paipersum

# 2. Install dependencies
npm install

# 3. Set up environment variables
cp .env.example .env
# Edit .env with your configuration

# 4. Start the API
cd apps/api
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -r requirements.txt
uvicorn main:app --reload

# 5. In a new terminal, start the web app
cd apps/web
npm install
npm run dev

# 6. Open http://localhost:5173 in your browser

Using Docker (Recommended for Production)

# Start all services
docker-compose up -d

# View logs
docker-compose logs -f

# Stop services
docker-compose down

Services will be available at:

Web App: http://localhost:5173
API: http://localhost:8000
API Docs: http://localhost:8000/docs
MinIO Console: http://localhost:9001 (minio/minio12345)

📁 Project Structure

paipersum/
├── apps/
│   ├── web/                    # React + Vite frontend
│   │   ├── src/
│   │   │   ├── components/     # Reusable UI components
│   │   │   ├── lib/           # API client, schemas
│   │   │   ├── pages/         # Page components
│   │   │   ├── App.tsx        # Main application
│   │   │   └── main.tsx       # Entry point
│   │   ├── public/            # Static assets, legal pages
│   │   └── package.json
│   │
│   ├── api/                   # FastAPI backend
│   │   ├── main.py            # FastAPI application
│   │   ├── obs.py             # Observability & logging
│   │   ├── security.py        # Rate limiting, headers
│   │   ├── ingest.py          # PDF/OCR processing
│   │   ├── report.py          # PDF report generation
│   │   └── requirements.txt
│   │
│   └── extension/             # Browser extension
│       ├── src/
│       │   └── content.ts     # Content script
│       └── public/
│           └── manifest.json
│
├── docker-compose.yml         # Local development stack
├── .github/workflows/         # CI/CD pipelines
└── README.md

🎨 Tech Stack

Frontend

React 18 - UI framework
TypeScript - Type safety
Vite - Build tool & dev server
Tailwind CSS - Styling & design system
Zod - Runtime type validation
Axios - HTTP client

Backend

FastAPI - High-performance Python API
Pydantic - Data validation
PDFMiner - PDF text extraction
Tesseract - OCR for scanned documents
FPDF - PDF report generation
PostgreSQL - Database (optional, for auth)
Redis - Caching & rate limiting
MinIO - S3-compatible object storage

DevOps

Docker - Containerization
GitHub Actions - CI/CD
Uvicorn - ASGI server

📖 Usage

Web Interface

Paste Text: Copy legal text directly into the textarea
Upload File: Drag & drop or select PDF, DOC, DOCX, TXT files
Analyze: Click "Analyze" to process the document
Review Results: See risk score, confidence, and detected clauses
Export PDF: Download a professional report

Browser Extension

Install:

cd apps/extension
npm install
npm run build

Load in Chrome:
- Open chrome://extensions/
- Enable "Developer mode"
- Click "Load unpacked"
- Select apps/extension/dist folder
Use:
- Navigate to any webpage with legal text
- Look for the PaiperSum panel in the top-right
- Click "Analyze This Page"

API

# Analyze text
curl -X POST http://localhost:8000/analyze \
  -H "Content-Type: application/json" \
  -d '{"text": "I agree to indemnify and hold harmless..."}'

# Analyze file
curl -X POST http://localhost:8000/analyze-file \
  -F "[email protected]"

# Export PDF report
curl -X POST http://localhost:8000/export/pdf \
  -H "Content-Type: application/json" \
  -d '{"text": "..."}' \
  --output report.pdf

API Documentation: http://localhost:8000/docs

⚙️ Configuration

Environment Variables

Create .env file in the root directory:

# API Configuration
DATABASE_URL=postgresql+psycopg://ps:ps@localhost:5432/paipersum
REDIS_URL=redis://localhost:6379
S3_ENDPOINT=http://localhost:9000
S3_ACCESS_KEY=minio
S3_SECRET_KEY=minio12345
S3_BUCKET=paipersum
JWT_SECRET=your-secret-key-change-in-production
STRIPE_SECRET=sk_test_xxx
STRIPE_WEBHOOK_SECRET=whsec_xxx
SENTRY_DSN=https://[email protected]/xxx
ALLOWED_ORIGINS=*

# Web Configuration
VITE_API_URL=http://localhost:8000

Customization

Add Custom Clauses (apps/api/main.py):

RULES = [
    (r"your-regex-pattern", "Clause Title", "Plain English summary", 'risk-level'),
    # risk-level: 'red', 'yellow', or 'green'
]

Adjust Risk Weights (apps/api/main.py):

RISK_WEIGHTS = {'red': 30, 'yellow': 12, 'green': 4}

Rate Limiting (apps/api/security.py):

WINDOW = 10  # seconds
LIMIT = 30   # requests per window

🧪 Testing

# Run all tests
npm test

# Test specific app
npm --workspace apps/web test

Manual Testing Checklist

Text analysis with sample contract
File upload (PDF, DOCX, TXT)
Large file handling (>1MB)
Invalid file format rejection
PDF export functionality
Browser extension on various sites
Mobile responsiveness
Accessibility (keyboard navigation, screen readers)

🚢 Deployment

Docker Production Deployment

# Build images
docker-compose -f docker-compose.yml build

# Run in production mode
docker-compose -f docker-compose.yml up -d

# View logs
docker-compose logs -f api web

# Scale workers
docker-compose up -d --scale api=3

Platform Deployment

Deploy to Fly.io

# Install flyctl
curl -L https://fly.io/install.sh | sh

# Login
flyctl auth login

# Deploy API
cd apps/api
flyctl launch
flyctl deploy

# Deploy Web
cd ../web
flyctl launch
flyctl deploy

Deploy to Render

Connect your GitHub repository
Create new Web Service for API
- Build Command: pip install -r requirements.txt
- Start Command: uvicorn main:app --host 0.0.0.0 --port $PORT
Create new Static Site for Web
- Build Command: cd apps/web && npm install && npm run build
- Publish Directory: apps/web/dist

Deploy to Railway

# Install Railway CLI
npm i -g @railway/cli

# Login and deploy
railway login
railway init
railway up

🔒 Security & Compliance

Security Features Implemented

✅ HTTPS encryption (in production)
✅ Rate limiting (30 req/10sec per IP)
✅ Security headers (CSP, HSTS, X-Frame-Options)
✅ Input validation & sanitization
✅ File upload restrictions (type, size)
✅ Request ID tracking
✅ Structured logging
✅ Error handling without data leaks

Legal Compliance

✅ Not Legal Advice Disclaimer - Prominent throughout UI
✅ Terms of Service - /terms.html
✅ Privacy Policy - /privacy.html
✅ GDPR Compliant - Data minimization, right to deletion
✅ CCPA Compliant - California privacy rights
✅ No Attorney-Client Relationship - Clear disclosure

Data Handling

🔒 Documents not stored by default (processed in memory)
🔒 TLS encryption in transit
🔒 No human review of your documents
🔒 Analysis results deleted after 90 days (configurable)

🛡️ Disclaimer

⚠️ IMPORTANT: THIS IS NOT LEGAL ADVICE

PaiperSum provides automated document analysis for informational purposes only. This service:

Does NOT constitute legal advice
Does NOT create an attorney-client relationship
May miss important clauses or misinterpret legal language
Should NOT be relied upon for legal decisions
Is NOT a substitute for consultation with a licensed attorney

Always consult a qualified attorney licensed in your jurisdiction before making legal decisions.

💰 Business Model / Monetization

Pricing Tiers

Tier	Price	Features
Free	$0	30 documents/month, basic analysis
Pro	$12/mo	Unlimited documents, PDF export, priority support
Team	$39/user/mo	Collaboration, API access, custom clauses
Enterprise	Custom	SLA, dedicated support, on-premise deployment

Stripe Integration

See apps/api/billing.py for webhook handlers and checkout flow.

🤝 Contributing

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

# Fork the repo
# Create a feature branch
git checkout -b feature/amazing-feature

# Make your changes
# Commit with clear messages
git commit -m "Add amazing feature"

# Push to your fork
git push origin feature/amazing-feature

# Open a Pull Request

Development Guidelines

Follow TypeScript/Python style guides
Add tests for new features
Update documentation
Ensure accessibility compliance
Add error handling

📊 Roadmap

MVP (Current)

Phase 2 (Q1 2026)

Phase 3 (Q2 2026)

📞 Support

Documentation: docs.paipersum.com
Email: [email protected]
Issues: GitHub Issues
Discord: Join our community

📜 License

MIT License - see LICENSE file for details.

🙏 Acknowledgments

Legal clause patterns inspired by ToS;DR
UI design inspired by modern SaaS best practices
Built with open-source technologies

📈 Analytics & Monitoring

Key Metrics to Track

Monthly Active Users (MAU)
Documents analyzed per day
Conversion rate (free → paid)
Average risk score
Model confidence trends
API latency (p95, p99)
Error rates

Monitoring Stack

Sentry: Error tracking
OpenTelemetry: Distributed tracing
Prometheus: Metrics collection
Grafana: Dashboards

Built with ❤️ for everyone who's ever clicked "I agree" without reading

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
.vscode		.vscode
apps		apps
backend		backend
node_modules		node_modules
server		server
.env		.env
.env.example		.env.example
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
BROWSER_EXTENSION_GUIDE.md		BROWSER_EXTENSION_GUIDE.md
COMPLETE_DEPLOYMENT_GUIDE.md		COMPLETE_DEPLOYMENT_GUIDE.md
COMPLETE_LAUNCH_GUIDE.md		COMPLETE_LAUNCH_GUIDE.md
COMPLETE_SETUP_GUIDE.md		COMPLETE_SETUP_GUIDE.md
DEPLOY_TO_VERCEL.md		DEPLOY_TO_VERCEL.md
FREE_BRANDING_GUIDE.md		FREE_BRANDING_GUIDE.md
GITHUB_DEPLOY.md		GITHUB_DEPLOY.md
LICENSE		LICENSE
NAMECHEAP_DNS_SETUP.md		NAMECHEAP_DNS_SETUP.md
PREMIUM_UI_CHECKLIST.md		PREMIUM_UI_CHECKLIST.md
PROJECT_ASSESSMENT_2025.md		PROJECT_ASSESSMENT_2025.md
README.md		README.md
config.env		config.env
demo-script.js		demo-script.js
docker-compose.yml		docker-compose.yml
package-lock.json		package-lock.json
package.json		package.json
paipersum5.png		paipersum5.png
railway.json		railway.json
settings.json		settings.json
test_app.py		test_app.py
vercel.json		vercel.json

Latest commit

History

Folders and files

Repository files navigation