🚀 RepoDoc - AI-Powered Code Documentation & Chat Platform

Transform your GitHub repositories into interactive, intelligent documentation

Demo · Documentation · Report Bug

✨ Features

🤖 AI-Powered Code Understanding

Intelligent Chat Interface: Ask questions about your codebase in natural language
Semantic Code Search: Find code by meaning, not just keywords
Context-Aware Responses: Get answers with file references and code snippets

📚 Automatic Documentation

Auto-Generated Docs: Create comprehensive documentation from your code
Interactive Wiki: Browse and search through your codebase structure
README Enhancement: Improve your README with AI suggestions

🔍 Repository Analytics

Language Statistics: Visualize your tech stack
Code Metrics: Track repository size, stars, forks, and activity
Dependency Insights: Understand your project dependencies

🛡️ Enterprise-Ready

Rate Limiting: Protect your API with built-in rate limiting
Error Tracking: Integrated monitoring and error reporting
Secure Authentication: OAuth integration with Clerk
Performance Monitoring: Track and optimize application performance

🏗️ Architecture

System Overview

┌─────────────────────────────────────────────────────────────────┐
│                         Frontend (Next.js)                       │
│  ┌──────────────┐  ┌──────────────┐  ┌────────────────────┐   │
│  │ Chat UI      │  │ Dashboard    │  │ Documentation      │   │
│  │              │  │              │  │ Generation         │   │
│  └──────────────┘  └──────────────┘  └────────────────────┘   │
└────────────────────────────┬────────────────────────────────────┘
                             │
                             │ REST API
                             │
┌────────────────────────────▼────────────────────────────────────┐
│                      API Routes (Next.js)                        │
│  ┌──────────────┐  ┌──────────────┐  ┌────────────────────┐   │
│  │ /api/query   │  │ /api/docs    │  │ /api/github        │   │
│  │              │  │              │  │                     │   │
│  └──────────────┘  └──────────────┘  └────────────────────┘   │
└────────────────────────────┬────────────────────────────────────┘
                             │
          ┌──────────────────┼──────────────────┐
          │                  │                  │
          ▼                  ▼                  ▼
┌─────────────────┐  ┌──────────────┐  ┌──────────────┐
│  Vector DB      │  │  PostgreSQL  │  │  GitHub API  │
│  (Embeddings)   │  │  (Metadata)  │  │              │
└─────────────────┘  └──────────────┘  └──────────────┘
          │                  │
          │                  │
          ▼                  ▼
┌──────────────────────────────────────────────┐
│         AI/ML Services                       │
│  ┌──────────────┐  ┌────────────────────┐   │
│  │ Google       │  │ OpenRouter         │   │
│  │ Gemini       │  │ (Multi-Model)      │   │
│  └──────────────┘  └────────────────────┘   │
└──────────────────────────────────────────────┘

Tech Stack

Frontend

Framework: Next.js 15.5 (App Router)
Language: TypeScript 5.0
Styling: Tailwind CSS 4.1
UI Components: Radix UI
State Management: Redux Toolkit
Forms: React Hook Form + Zod

Backend

Runtime: Node.js 20
Database: PostgreSQL (Prisma ORM)
Vector Storage: Custom implementation with embeddings
Authentication: Clerk
API: Next.js API Routes

AI/ML

LLM: Google Gemini + OpenRouter
Embeddings: LangChain
Vector Search: Custom RAG implementation

DevOps

Deployment: Vercel
Monitoring: Sentry (configured)
Testing: Jest + React Testing Library

🚀 Quick Start

Prerequisites

Node.js 18+ and npm/yarn
PostgreSQL database
GitHub account
Clerk account (for authentication)
Google AI API key or OpenRouter API key

Installation

Clone the repository

git clone https://github.com/yourusername/repodoc.git
cd repodoc

Install dependencies

npm install

Set up environment variables

cp .env.example .env

Edit .env with your credentials:

# Database
DATABASE_URL="postgresql://user:password@localhost:5432/repodoc"

# Clerk Authentication
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_xxxxx
CLERK_SECRET_KEY=sk_test_xxxxx
CLERK_WEBHOOK_SECRET=whsec_xxxxx

# AI APIs
GOOGLE_API_KEY=your_google_api_key
OPENROUTER_API_KEY=your_openrouter_key

# GitHub
GITHUB_TOKEN=ghp_xxxxx

# App
NEXT_PUBLIC_APP_URL=http://localhost:3000

Set up the database

npm run db:generate
npm run db:migrate

Run the development server

npm run dev

Open your browser

http://localhost:3000

📖 Usage

1. Connect Your Repository

Sign in with your GitHub account
Click "Create Project" in the dashboard
Enter your repository URL
Wait for the initial processing

2. Chat with Your Codebase

Navigate to the Chat page
Ask questions like:
- "How does authentication work?"
- "Explain the database schema"
- "Where is error handling implemented?"
Get instant answers with code references

3. Generate Documentation

Go to the Docs page
Click "Generate Documentation"
Review and customize the generated docs
Export or share your documentation

4. Explore Analytics

Visit the Dashboard
View repository statistics
Analyze language distribution
Track activity trends

🧪 Testing

Run all tests

npm test

Run tests in CI mode

npm run test:ci

Check test coverage

npm test -- --coverage

Type checking

npm run type-check

🏗️ Project Structure

repodoc/
├── __tests__/               # Test files
│   ├── components/
│   ├── lib/
│   └── api/
├── prisma/
│   ├── schema.prisma        # Database schema
│   └── migrations/          # Database migrations
├── public/                  # Static assets
├── src/
│   ├── app/                 # Next.js app directory
│   │   ├── (app)/          # Public pages
│   │   ├── (auth)/         # Auth pages
│   │   ├── (protected)/    # Protected pages
│   │   └── api/            # API routes
│   ├── components/          # React components
│   │   ├── ui/             # UI primitives
│   │   └── landing/        # Landing page components
│   ├── context/            # React contexts
│   ├── hooks/              # Custom hooks
│   ├── lib/                # Utility libraries
│   │   ├── actions.ts      # Server actions
│   │   ├── github.ts       # GitHub integration
│   │   ├── rag.ts          # RAG implementation
│   │   ├── monitoring.ts   # Error tracking
│   │   └── rate-limiter.ts # Rate limiting
│   └── provider/           # Context providers
├── .env.example            # Environment variables template
├── jest.config.js          # Jest configuration
├── next.config.ts          # Next.js configuration
└── package.json            # Dependencies

🔒 Security

Security Features

✅ Rate limiting on all API endpoints
✅ Input validation with Zod
✅ SQL injection protection (Prisma)
✅ XSS protection (Next.js built-in)
✅ CSRF protection
✅ Secure authentication (Clerk)
✅ Environment variable validation

Reporting Security Issues

If you discover a security vulnerability, please email security@repodoc.dev. Do not create public GitHub issues for security vulnerabilities.

📊 Performance

Optimization Techniques

✅ Server-side rendering (SSR)
✅ Static site generation (SSG)
✅ Image optimization (Next.js Image)
✅ Code splitting
✅ Tree shaking
✅ Compression (gzip/brotli)
✅ CDN caching
✅ Database query optimization
✅ Redis caching (planned)

Performance Metrics

Lighthouse Score: 95+
First Contentful Paint: < 1.5s
Time to Interactive: < 3.0s
Total Blocking Time: < 200ms

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

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

Code Style

Follow the existing code style
Run npm run lint before committing
Write tests for new features
Update documentation as needed

📝 Acknowledgments

Next.js - The React Framework
Vercel - Hosting Platform
Clerk - Authentication
Google AI - AI/ML Services
Radix UI - UI Components
Tailwind CSS - Styling

📞 Support

📧 Email: parbhat@parbhat.dev

Made by Parbhat Kapila

⬆ Back to Top

Name		Name	Last commit message	Last commit date
Latest commit History 103 Commits
__tests__		__tests__
prisma		prisma
public		public
src		src
.gitignore		.gitignore
API.md		API.md
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
DEPLOYMENT.md		DEPLOYMENT.md
LOADING_ANIMATION_GUIDE.md		LOADING_ANIMATION_GUIDE.md
PROJECT_IMPROVEMENTS.md		PROJECT_IMPROVEMENTS.md
QUICKSTART.md		QUICKSTART.md
README.md		README.md
SECURITY.md		SECURITY.md
TROUBLESHOOTING.md		TROUBLESHOOTING.md
components.json		components.json
eslint.config.mjs		eslint.config.mjs
jest.config.js		jest.config.js
jest.setup.js		jest.setup.js
next.config.ts		next.config.ts
package-lock.json		package-lock.json
package.json		package.json
postcss.config.mjs		postcss.config.mjs
revert-last-commits.sh		revert-last-commits.sh
tsconfig.json		tsconfig.json

parbhatkapila4/RepoDocs

Folders and files

Latest commit

History

Repository files navigation