Repo Explorer

Repo Explorer is an intelligent developer tool that allows you to have a conversation with any GitHub repository. By leveraging RAG (Retrieval-Augmented Generation) and LLMs, it helps you understand codebases faster, find bugs, and generate documentation effortlessly.

Features

• Chat with Codebase: Ask questions about architecture, specific functions, or logic flow.
• Smart Ingestion: Automatically clones, processes, and embeds repository content for semantic search.
• README Generator: Generate comprehensive README files for any project with a single click.
• Secure Authentication: User accounts and data persisted securely using MongoDB.
• Dark Mode: Fully responsive UI with seamless light/dark mode switching.

Tech Stack

Frontend

• Framework: Next.js 16 (App Router)
• UI Library: shadcn/ui
• Styling: Tailwind CSS
• State Management: React Context + Hooks

Backend

• API: FastAPI (Python)
• LLM Orchestration: LangChain
• Vector Store: Pinecone
• Database: MongoDB
• AI Models: Ollama (Local) / Gemini (Cloud)

Getting Started

Prerequisites

• Node.js 18+
• Python 3.10+
• MongoDB instance (Local or Atlas)
• Pinecone API Key
• Ollama (for local inference)

Installation

1. Clone the repository

   git clone https://github.com/yourusername/repo-explorer.git
   cd repo-explorer

2. Setup Backend

   cd server
   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install -r requirements.txt

   Create a .env file in server/ with your API keys (Pinecone, MongoDB, etc.).

3. Setup Frontend

   cd client
   npm install

Running the Application

1. Start the Backend Server

   # In server/ directory
   uvicorn main:app --reload

2. Start the Frontend Client

   # In client/ directory
   npm run dev

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

Usage

1. Sign Up/Login: Create an account to save your sessions.
2. Ingest a Repo: Paste a GitHub URL (e.g., https://github.com/facebook/react) into the chat.
3. Start Chatting: Ask "How does the reconciliation algorithm work?" or "Where is the entry point?".
4. Generate Docs: Switch to the README tab to generate documentation for the repo.

Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

License

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