Dev Compass 🧭

Note

Dev Compass is an application that helps you to analyze GitHub repositories easily using our chat assistant and workflow diagram generator so that you spend less time on finding and more on working on the codebases. We also have a Audio Preview feature that allows you get an instant audio preview of codebase so that you can also listen what the codebase is doing and how — all powered by Agno and Groq.

Demo Video

🌟 Features

• Repository Setup: Add any public GitHub repo for analysis.
• Dashboard: View repo metadata, recent commits, and activity.
• Chat: Ask questions about the codebase.
• File Tree: Visualize project structure with Mermaid diagrams.
• Audio: Generate and play AI-powered audio previews about the repo.
• Past Repos: Revisit or delete previously analyzed repositories.

Tech Stack

• Backend: FastAPI, SQLAlchemy, PyGithub, Agno, LLAMA through Groq, ChromaDB
• Frontend: React, Tailwind CSS, Wouter (routing)
• Database: SQLite

💻 Getting Started

Prerequisites

Before you begin, ensure you have the following:

• Python 3.x
• Node.js
• Groq API Key: Sign up at Groq and generate your API key.
• GitHub Access Token: Create a token in your GitHub settings and add it to your .env file.

Note: Make sure to configure your .env file with the required API keys and tokens before starting the application.

1. Clone the Repository

git clone https://github.com/abhinavthedev/devcompass.git
cd devcompass

2. Backend Setup

cd backend

uv venv

.venv\Scripts\activate  # On Windows

uv sync

• Configure your environment variables in .env (see .env.example).
• Start the backend server:

uvicorn main:app --reload

• Make sure your backend server runs at http://127.0.0.1:8000

3. Frontend Setup

cd frontend

bun install

bun run dev

Usage

1. Open the frontend app in your browser (usually at http://localhost:5173).
2. Enter a GitHub repository URL on the index page and click "Analyze".
3. Wait for processing; you’ll be redirected to the dashboard when ready.
4. Explore features: Chat, File Tree, Audio, and revisit past repos.

👤 Author

Abhinav

---

📄 License

Dev Compass is licensed under the MIT License. See the LICENSE file for more details.

---

🌟 If you find this project helpful, please give it a star on GitHub! 🌟