Skip to content

Iron-Mark/Hackathon-LexInsights

BranchesTags
 
 

Repository files navigation

🏛️ LexInSight

AI-Powered Philippine Legal Compliance Assistant

Build Status Version License Next.js TypeScript

LexInSight is an intelligent, AI-powered chat application designed to help individuals, businesses, and organizations navigate the complex landscape of Philippine legal compliance. Through advanced document analysis and conversational AI, LexInSight makes legal compliance accessible, understandable, and actionable.

📑 Table of Contents

🎯 Overview

What is LexInSight?

LexInSight is a comprehensive legal compliance platform that combines:

  • AI-Powered Chat - Natural language interface for legal queries
  • Document Analysis - Automated compliance checking for uploaded documents
  • Knowledge Base - Extensive Philippine legal and regulatory information
  • Real-time Assistance - Instant answers to compliance questions

Who is it for?

  • Small Businesses - Navigate regulatory requirements
  • Compliance Officers - Streamline compliance workflows
  • Legal Professionals - Quick reference and document analysis
  • Government Agencies - Assist constituents with compliance
  • Students & Researchers - Learn about Philippine law

Why LexInSight?

  • ✅ Accessible - Complex legal language made simple
  • ✅ Fast - Instant answers, no waiting for consultations
  • ✅ Comprehensive - Covers major Philippine laws and regulations
  • ✅ Secure - Enterprise-grade security and privacy
  • ✅ Affordable - Cost-effective compliance solution

✨ Key Features

💬 Dual-Mode Chat Interface

General Mode

  • Ask questions about Philippine laws and regulations
  • Get explanations of legal requirements
  • Learn about compliance procedures
  • Receive step-by-step guidance
  • Access to extensive legal knowledge base

Example Queries:

  • "What are the requirements for RA 10173 Data Privacy Act?"
  • "How do I register a business in Manila?"
  • "What permits do I need for construction?"

Compliance Mode

  • Upload documents for automated analysis
  • Check compliance against Philippine legal standards
  • Receive detailed compliance reports
  • Identify gaps and recommendations
  • Generate compliance checklists

Supported Documents:

  • PDF files
  • Word documents (.doc, .docx)
  • Markdown files (.md)
  • Text files (.txt)

📄 Advanced Document Analysis

  • Multi-Document Support - Analyze up to 3 documents simultaneously
  • File Size Limit - 5MB per file
  • Real-time Processing - Instant analysis results
  • Detailed Reports - Comprehensive compliance assessments
  • Actionable Insights - Clear next steps and recommendations

🔐 Enterprise-Grade Security

  • Authentication - Secure email/password authentication via Supabase
  • Row-Level Security - Database-level access control
  • Encrypted Storage - Files encrypted at rest and in transit
  • User Isolation - Complete data separation between users
  • Audit Trails - Track all document access and modifications

📊 Document Management

  • Centralized Dashboard - View all uploaded documents
  • Download & Delete - Full control over your files
  • Metadata Tracking - File size, type, upload date
  • Search & Filter - Find documents quickly
  • Version History - Track document changes (coming soon)

🎨 Modern User Experience

  • Responsive Design - Works on desktop, tablet, and mobile
  • Dark Mode - Eye-friendly interface (coming soon)
  • Smooth Animations - Polished, professional feel
  • Accessibility - WCAG 2.1 compliant
  • Fast Loading - Optimized performance

🚀 Tech Stack

Frontend

Technology Version Purpose
Next.js 16.0.1 React framework with App Router
React 19.0 UI library
TypeScript 5.0+ Type-safe development
Tailwind CSS 3.4+ Utility-first styling
Framer Motion 11.0+ Smooth animations
Zustand 4.5+ State management
Lucide React Latest Icon library

Backend

Technology Purpose
Supabase Backend as a Service
PostgreSQL Relational database
Supabase Auth User authentication
Supabase Storage File storage
Row Level Security Data access control
Real-time Live updates

AI/ML

Technology Purpose
RAG (Retrieval-Augmented Generation) Document analysis
WebSocket Real-time AI responses
Vector Search Semantic document search

Development Tools

Tool Purpose
ESLint Code linting
Prettier Code formatting
Git Version control
npm Package management

🏁 Getting Started

Prerequisites

Before you begin, ensure you have:

  • Node.js 18.0 or higher (Download)
  • npm 9.0 or higher (comes with Node.js)
  • Git (Download)
  • Supabase Account (Sign up)
  • Code Editor (VS Code recommended)

Quick Start

# Clone the repository
git clone https://github.com/KpG782/lexiph.git

# Navigate to project directory
cd lexiph/lexiph

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env.local
# Edit .env.local with your Supabase credentials

# Run development server
npm run dev

Open http://localhost:3000 in your browser.

🛠️ Installation

Step 1: Clone Repository

git clone https://github.com/KpG782/lexiph.git
cd lexiph/lexiph

Step 2: Install Dependencies

npm install

This will install all required packages including:

  • Next.js and React
  • Supabase client
  • Tailwind CSS
  • Framer Motion
  • And more...

Step 3: Supabase Setup

3.1 Create Supabase Project

  1. Go to Supabase Dashboard
  2. Click "New Project"
  3. Fill in project details
  4. Wait for project to be created

3.2 Get API Credentials

  1. Go to Settings → API
  2. Copy Project URL
  3. Copy anon/public key

3.3 Configure Environment Variables

Create .env.local in the project root:

# Supabase Configuration
NEXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key-here

# Optional: Service Role Key (for admin operations)
SUPABASE_SERVICE_ROLE_KEY=your-service-role-key

Step 4: Database Setup

4.1 Create Tables

  1. Open Supabase Dashboard → SQL Editor
  2. Click New Query
  3. Copy contents of supabase-setup.sql
  4. Click Run

This creates:

  • profiles - User profiles
  • chats - Chat conversations
  • messages - Chat messages
  • documents - File metadata
  • compliance_reports - Analysis reports
  • search_history - Search queries

4.2 Set Up Storage

  1. Go to Storage → New Bucket

  2. Name: documents

  3. Public: OFF

  4. File size limit: 5242880 (5MB)

  5. Allowed MIME types:

    application/pdf
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
text/plain
text/markdown

  6. Run supabase-storage-setup.sql in SQL Editor

4.3 Insert Sample Data (Optional)

# For testing, insert sample data
# Run in SQL Editor:
supabase-insert-data-ken.sql

Step 5: Run Development Server

npm run dev

Visit http://localhost:3000

Step 6: Build for Production

npm run build
npm start

📖 Usage Guide

Creating an Account

  1. Navigate to /auth/signup
  2. Enter email and password
  3. Click "Sign Up"
  4. Verify email (if enabled)
  5. Login at /auth/login

Using General Mode

  1. Ask a Question

    • Type your legal question in the chat input
    • Press Enter or click Send
    • Receive AI-powered response

  2. Example Questions

    • "What are the requirements for RA 10173?"
    • "How do I get a business permit in Manila?"
    • "What is the process for SEC registration?"

  3. Follow-up Questions

    • Continue the conversation
    • Ask for clarification
    • Request more details

Using Compliance Mode

  1. Switch to Compliance Mode

    • Toggle the mode switch at bottom of chat

  2. Upload Documents

    • Drag and drop files onto the chat area
    • Or click to browse and select files
    • Up to 3 files, 5MB each

  3. Add Query (Optional)

    • Type specific questions about your documents
    • Example: "Check compliance with RA 10121"

  4. Analyze

    • Click Send button
    • Wait for analysis to complete
    • View detailed compliance report

  5. Review Results

    • Read compliance score
    • Check compliant sections
    • Review recommendations
    • Download report (coming soon)

Managing Documents

  1. View All Documents

    • Click "Uploaded Files" button
    • Or navigate to /documents

  2. Download Documents

    • Click download icon next to file
    • File downloads to your computer

  3. Delete Documents

    • Click delete icon
    • Confirm deletion
    • File removed from storage and database

Chat Management

  1. Create New Chat

    • Click "New Chat" button
    • Start typing to create chat

  2. View Chat History

    • All chats listed in sidebar
    • Click to open any chat

  3. Delete Chat

    • Hover over chat in sidebar
    • Click delete icon
    • Confirm deletion

🏗️ Project Structure

lexiph/
├── app/                          # Next.js App Router
│   ├── auth/                    # Authentication pages
│   │   ├── login/              # Login page
│   │   ├── signup/             # Signup page
│   │   ├── callback/           # Auth callback
│   │   └── verify-email/       # Email verification
│   ├── chat/                    # Chat interface
│   │   ├── page.tsx            # Main chat page
│   │   └── [chatId]/           # Individual chat
│   ├── documents/               # Document management
│   │   └── page.tsx            # Documents page
│   ├── layout.tsx               # Root layout
│   └── page.tsx                 # Home page
│
├── components/                   # React components
│   ├── auth/                    # Auth components
│   │   ├── login-form.tsx
│   │   └── signup-form.tsx
│   ├── chat/                    # Chat components
│   │   ├── chat-container.tsx
│   │   ├── chat-input.tsx
│   │   ├── chat-messages.tsx
│   │   ├── message-bubble.tsx
│   │   ├── empty-state.tsx
│   │   ├── centered-input.tsx
│   │   ├── uploaded-files-list.tsx
│   │   ├── uploaded-files-dialog.tsx
│   │   ├── user-documents-list.tsx
│   │   └── ...
│   ├── layout/                  # Layout components
│   │   ├── chat-header.tsx
│   │   └── user-menu.tsx
│   ├── navigation/              # Navigation
│   │   └── app-sidebar.tsx
│   └── ui/                      # Reusable UI
│       ├── button.tsx
│       ├── input.tsx
│       ├── dialog.tsx
│       └── toast.tsx
│
├── lib/                          # Utilities & services
│   ├── store/                   # Zustand stores
│   │   ├── auth-store.ts
│   │   ├── chat-store.ts
│   │   ├── chat-mode-store.ts
│   │   ├── file-upload-store.ts
│   │   ├── rag-store.ts
│   │   └── sidebar-store.ts
│   ├── services/                # API services
│   │   ├── rag-api.ts
│   │   └── deep-search-api.ts
│   ├── supabase/                # Supabase client
│   │   ├── client.ts
│   │   └── README.md
│   └── utils.ts                 # Utility functions
│
├── types/                        # TypeScript types
│   └── index.ts
│
├── public/                       # Static assets
│   ├── logo/
│   └── ...
│
├── styles/                       # Global styles
│   └── globals.css
│
├── supabase-setup.sql           # Database schema
├── supabase-storage-setup.sql   # Storage policies
├── supabase-insert-data-ken.sql # Sample data
├── supabase-insert-data-mark.sql # Sample data
│
├── .env.local                    # Environment variables
├── .gitignore                    # Git ignore rules
├── next.config.ts                # Next.js config
├── tailwind.config.ts            # Tailwind config
├── tsconfig.json                 # TypeScript config
├── package.json                  # Dependencies
└── README.md                     # This file

🗄️ Database Schema

Tables Overview

Table Purpose Rows (Est.)
profiles User profiles 1 per user
chats Chat conversations ~10 per user
messages Chat messages ~100 per chat
documents File metadata ~20 per user
compliance_reports Analysis reports ~10 per user
search_history Search queries ~50 per user

Detailed Schema

profiles

CREATE TABLE profiles (
  id UUID PRIMARY KEY REFERENCES auth.users(id),
  email TEXT UNIQUE NOT NULL,
  full_name TEXT,
  avatar_url TEXT,
  created_at TIMESTAMPTZ DEFAULT NOW(),
  updated_at TIMESTAMPTZ DEFAULT NOW()
);

chats

CREATE TABLE chats (
  id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
  user_id UUID NOT NULL REFERENCES auth.users(id),
  title TEXT NOT NULL,
  mode TEXT NOT NULL DEFAULT 'general',
  created_at TIMESTAMPTZ DEFAULT NOW(),
  updated_at TIMESTAMPTZ DEFAULT NOW()
);

messages

CREATE TABLE messages (
  id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
  chat_id UUID NOT NULL REFERENCES chats(id) ON DELETE CASCADE,
  role TEXT NOT NULL CHECK (role IN ('user', 'assistant', 'system')),
  content TEXT NOT NULL,
  metadata JSONB DEFAULT '{}'::jsonb,
  created_at TIMESTAMPTZ DEFAULT NOW()
);

documents

CREATE TABLE documents (
  id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
  user_id UUID NOT NULL REFERENCES auth.users(id),
  chat_id UUID REFERENCES chats(id),
  file_name TEXT NOT NULL,
  file_size INTEGER NOT NULL,
  file_type TEXT NOT NULL,
  storage_path TEXT NOT NULL,
  status TEXT NOT NULL DEFAULT 'pending',
  metadata JSONB DEFAULT '{}'::jsonb,
  created_at TIMESTAMPTZ DEFAULT NOW(),
  updated_at TIMESTAMPTZ DEFAULT NOW()
);

Indexes

-- Performance indexes
CREATE INDEX idx_chats_user_id ON chats(user_id);
CREATE INDEX idx_messages_chat_id ON messages(chat_id);
CREATE INDEX idx_documents_user_id ON documents(user_id);
CREATE INDEX idx_chats_created_at ON chats(created_at DESC);

Row Level Security (RLS)

All tables have RLS enabled with policies:

  • Users can only SELECT their own data
  • Users can only INSERT their own data
  • Users can only UPDATE their own data
  • Users can only DELETE their own data

🔌 API Documentation

Authentication

Sign Up

POST /auth/signup
Body: { email: string, password: string, full_name?: string }
Response: { user, session }

Login

POST /auth/login
Body: { email: string, password: string }
Response: { user, session }

Logout

POST /auth/logout
Response: { success: boolean }

Chat Operations

Create Chat

POST /api/chats
Body: { title: string, mode: 'general' | 'compliance' }
Response: { chat: Chat }

Get Chats

GET /api/chats
Response: { chats: Chat[] }

Delete Chat

DELETE /api/chats/:id
Response: { success: boolean }

Document Operations

Upload Document

POST /api/documents
Body: FormData { file: File, chat_id?: string }
Response: { document: Document }

Get Documents

GET /api/documents
Response: { documents: Document[] }

Delete Document

DELETE /api/documents/:id
Response: { success: boolean }

🔐 Security

Authentication & Authorization

  • Supabase Auth - Industry-standard authentication
  • JWT Tokens - Secure session management
  • Password Hashing - bcrypt with salt
  • Email Verification - Optional email confirmation
  • Session Expiry - Automatic token refresh

Data Protection

  • Row Level Security - Database-level access control
  • Encrypted Storage - AES-256 encryption at rest
  • HTTPS Only - TLS 1.3 for data in transit
  • Signed URLs - Temporary file access
  • Input Validation - Prevent injection attacks

File Security

  • Type Validation - Only allowed file types
  • Size Limits - 5MB maximum per file
  • Virus Scanning - (Coming soon)
  • User Isolation - Files stored per user
  • Access Logs - Track all file access

Best Practices

  • ✅ Never commit .env.local
  • ✅ Use environment variables for secrets
  • ✅ Enable email verification in production
  • ✅ Regular security audits
  • ✅ Keep dependencies updated
  • ✅ Monitor for suspicious activity

⚡ Performance

Optimization Techniques

  • Code Splitting - Lazy load components
  • Image Optimization - Next.js Image component
  • Caching - Browser and CDN caching
  • Database Indexes - Fast query performance
  • Connection Pooling - Efficient database connections

Performance Metrics

Metric Target Current
First Contentful Paint < 1.5s ~1.2s
Time to Interactive < 3.0s ~2.5s
Largest Contentful Paint < 2.5s ~2.0s
Cumulative Layout Shift < 0.1 ~0.05

Monitoring

  • Vercel Analytics - Real-time performance monitoring
  • Supabase Logs - Database query performance
  • Error Tracking - Sentry integration (coming soon)

🧪 Testing

Run Tests

# Unit tests
npm test

# Integration tests
npm run test:integration

# E2E tests
npm run test:e2e

# Coverage report
npm run test:coverage

Test Structure

tests/
├── unit/              # Unit tests
├── integration/       # Integration tests
└── e2e/              # End-to-end tests

Testing Tools

  • Jest - Test runner
  • React Testing Library - Component testing
  • Playwright - E2E testing
  • MSW - API mocking

🚢 Deployment

Vercel (Recommended)

  1. Connect Repository

    # Install Vercel CLI
npm i -g vercel

# Deploy
vercel

  2. Configure Environment Variables

    • Add NEXT_PUBLIC_SUPABASE_URL
    • Add NEXT_PUBLIC_SUPABASE_ANON_KEY

  3. Deploy

    vercel --prod

Manual Deployment

# Build
npm run build

# Start production server
npm start

Environment Setup

# Production
NODE_ENV=production
NEXT_PUBLIC_SUPABASE_URL=your_production_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_production_key

🤝 Contributing

We welcome contributions! Here's how:

Getting Started

  1. Fork the repository
  2. Clone your fork 
    git clone https://github.com/your-username/lexiph.git
  3. Create a branch 
    git checkout -b feature/amazing-feature
  4. Make changes
  5. Commit 
    git commit -m 'Add amazing feature'
  6. Push 
    git push origin feature/amazing-feature
  7. Open Pull Request

Code Style

  • Follow TypeScript best practices
  • Use Prettier for formatting
  • Write meaningful commit messages
  • Add tests for new features
  • Update documentation

Pull Request Guidelines

  • Clear description of changes
  • Link related issues
  • Include screenshots for UI changes
  • Ensure tests pass
  • Update documentation

🗺️ Roadmap

Phase 1: Core Features (Current)

  • User authentication
  • Chat interface
  • Document upload
  • Compliance analysis
  • Document management

Phase 2: Enhanced Features (Q1 2025)

  • Multi-language support (Filipino, English)
  • Advanced document comparison
  • Compliance templates
  • Export reports to PDF
  • Email notifications

Phase 3: Advanced Features (Q2 2025)

  • Mobile app (iOS, Android)
  • API access for developers
  • Batch document processing
  • Compliance calendar
  • Team collaboration

Phase 4: Enterprise Features (Q3 2025)

  • SSO integration
  • Custom branding
  • Advanced analytics
  • Audit logs
  • SLA guarantees

❓ FAQ

General Questions

Q: Is LexInSight free to use? A: Currently in beta, free for all users.

Q: What Philippine laws are covered? A: Major laws including RA 10173 (Data Privacy), RA 10121 (Disaster Risk Reduction), RA 9003 (Solid Waste Management), Labor Code, and more.

Q: Can I use this for legal advice? A: LexInSight provides information and guidance but is not a substitute for professional legal advice.

Technical Questions

Q: What file types are supported? A: PDF, Word (.doc, .docx), Markdown (.md), and Text (.txt) files.

Q: What's the file size limit? A: 5MB per file, up to 3 files at once.

Q: Is my data secure? A: Yes, we use enterprise-grade security with encryption and Row Level Security.

Q: Can I delete my data? A: Yes, you can delete individual documents or your entire account.

📞 Support

Get Help

Report a Bug

  1. Check existing issues
  2. Create new issue with:
    • Clear description
    • Steps to reproduce
    • Expected vs actual behavior
    • Screenshots if applicable

📄 License

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

👥 Team

Core Team

Ken Patrick Garcia
Ken Patrick Garcia
Full Stack Developer
GitHub 		Jam Villarosa
Jam Villarosa
AI/ML Engineer
GitHub 		Mark Siazon
Mark Siazon
UI/UX Designer
GitHub 		Ashlyn Torres
Ashlyn Torres
Project Manager
LinkedIn

Roles & Responsibilities

🚀 Ken Patrick Garcia - Full Stack Developer

  • Frontend development (Next.js, React, TypeScript)
  • Backend integration (Supabase, API design)
  • Database architecture and optimization
  • State management and data flow
  • Performance optimization
  • Code review and quality assurance

🤖 Jam Villarosa - AI/ML Engineer

  • RAG (Retrieval-Augmented Generation) implementation
  • Document analysis algorithms
  • AI model integration and optimization
  • Natural language processing
  • Vector search and embeddings
  • ML pipeline development

🎨 Mark Siazon - UI/UX Designer

  • User interface design
  • User experience research
  • Design system creation
  • Wireframing and prototyping
  • Accessibility compliance
  • Visual design and branding

📋 Ashlyn Torres - Project Manager

  • Project planning and coordination
  • Sprint management and agile methodology
  • Stakeholder communication
  • Requirements gathering
  • Timeline and milestone tracking
  • Team collaboration facilitation

Contributors

Thanks to all contributors who have helped make LexInSight better!

Want to contribute? Check out our Contributing Guidelines.

🙏 Acknowledgments

Special Thanks

  • Philippine Government - For making legal information accessible and promoting digital transformation
  • Department of Justice (DOJ) - For comprehensive legal resources
  • National Privacy Commission (NPC) - For Data Privacy Act guidance

Technology Partners

  • Supabase - For excellent backend infrastructure and real-time capabilities
  • Next.js Team - For the amazing React framework and developer experience
  • Vercel - For seamless hosting, deployment, and edge network
  • Tailwind Labs - For the utility-first CSS framework

Open Source Community

Special thanks to the maintainers and contributors of:

  • React and React ecosystem
  • TypeScript
  • Framer Motion
  • Zustand
  • Lucide Icons
  • And countless other open source projects

Inspiration & Support

  • Legal Tech Community - For pioneering accessible legal solutions
  • Philippine Startup Ecosystem - For fostering innovation
  • Our Beta Testers - For valuable feedback and suggestions
  • University of Makati - For academic support and resources

📊 Project Stats

GitHub stars GitHub forks GitHub issues GitHub pull requests

Built with ❤️ for Philippine Legal Compliance

🏗️ Built By

Team LexInSight

  • Ken Patrick Garcia (Full Stack Developer)
  • Jam Villarosa (AI/ML Engineer)
  • Mark Siazon (UI/UX Designer)
  • Ashlyn Torres (Project Manager)

Website • Documentation • Report Bug • Request Feature

© 2025 LexInSight. All rights reserved.

About

LexInSight is an intelligent, AI-powered chat application designed to help individuals, businesses, and organizations navigate the complex landscape of Philippine legal compliance. Through advanced document analysis and conversational AI, LexInSight makes legal compliance accessible, understandable, and actionable.

lexinsights.vercel.app

Topics

hackathon codekada devkada-2025 codekada-2025 devkada

Resources

Readme
Activity

Stars

4 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 88.6%
  • CSS 7.2%
  • PLpgSQL 4.1%
  • JavaScript 0.1%