📑 CodeMentor AI - Complete Index & Navigation Guide

🗺️ Quick Navigation

📖 Start Here

README.md - Project overview, features, and tech stack
QUICK_START.md - Get running in 5 minutes
COMPLETION_REPORT.md - Project summary and achievements

🔧 Setup & Deployment

SETUP_GUIDE.md - Detailed installation and troubleshooting
.env.example - Environment variable template
docker-compose.yml - Docker container orchestration

🏗️ Architecture & Design

ARCHITECTURE.md - System design, data flow, and diagrams
PROJECT_SUMMARY.md - Implementation plan and overview

📚 Dependencies

requirements.txt - Python packages (backend)
frontend/package.json - Node packages (frontend)

📂 Project Structure

CodeMentorAI/
│
├── 📋 DOCUMENTATION (Start Here!)
│   ├── README.md ..................... Main documentation
│   ├── QUICK_START.md ................ 5-minute setup guide
│   ├── SETUP_GUIDE.md ................ Detailed installation
│   ├── ARCHITECTURE.md ............... System design
│   ├── PROJECT_SUMMARY.md ............ Implementation details
│   ├── COMPLETION_REPORT.md .......... Project completion summary
│   └── INDEX.md (this file) .......... Navigation guide
│
├── ⚙️ CONFIGURATION
│   ├── .env .......................... API keys & settings (configured)
│   ├── .env.example .................. Template for .env
│   ├── .gitignore .................... Git ignore rules
│   ├── requirements.txt .............. Python dependencies (67 packages)
│   └── docker-compose.yml ............ Docker container setup
│
├── 🔙 BACKEND (FastAPI + Python)
│   ├── Dockerfile .................... Backend container definition
│   └── app/
│       ├── __init__.py ............... Package initialization
│       ├── main.py ................... Main FastAPI application
│       ├── config.py ................. Configuration management
│       ├── api/
│       │   ├── routes/ ............... API route handlers
│       │   └── middleware/ ........... Request/response middleware
│       ├── services/
│       │   ├── groq_service.py ....... Groq API integration
│       │   ├── mcp_client.py ......... MCP server client
│       │   └── analysis_service.py ... Code analysis logic
│       ├── models/
│       │   ├── schemas.py ............ Pydantic data models
│       │   └── mongodb.py ............ MongoDB models
│       └── utils/
│           ├── prompts.py ............ LLM prompts
│           └── helpers.py ............ Utility functions
│
├── 🎨 FRONTEND (React + TypeScript)
│   ├── Dockerfile .................... Frontend container definition
│   ├── index.html .................... HTML entry point
│   ├── package.json .................. NPM dependencies (20+ packages)
│   ├── vite.config.ts ................ Vite build configuration
│   ├── tsconfig.json ................. TypeScript configuration
│   ├── tailwind.config.js ............ Tailwind CSS configuration
│   ├── postcss.config.js ............. PostCSS configuration
│   ├── .eslintrc.cjs ................. ESLint configuration
│   └── src/
│       ├── main.tsx .................. React entry point
│       ├── App.tsx ................... Main application component
│       ├── components/
│       │   ├── Header.tsx ............ Navigation header
│       │   ├── CodeEditor.tsx ........ Code input component
│       │   ├── ReviewPanel.tsx ....... Results display component
│       │   ├── History.tsx ........... Review history table
│       │   └── Analytics.tsx ......... Analytics dashboard
│       ├── hooks/
│       │   └── useReview.ts .......... Custom review hook
│       ├── services/
│       │   └── api.ts ................ API client
│       ├── store/
│       │   └── reviewStore.ts ........ Zustand state store
│       ├── styles/
│       │   └── globals.css ........... Global styles
│       └── types/
│           └── index.ts .............. TypeScript interfaces
│
└── 🔧 MCP SERVER (Future)
    └── mcp_server/
        ├── server.py ................. MCP server
        ├── tools/
        │   ├── code_parser.py ........ Code parsing
        │   └── vulnerability_rules.py  Security rules
        └── resources/
            └── rules/ ................ Analysis rules

🎯 What Each File Does

Core Application Files

Frontend Components

Header.tsx - Navigation tabs and branding
CodeEditor.tsx - Monaco editor with language selection
ReviewPanel.tsx - Display vulnerabilities and suggestions
History.tsx - Table of past reviews
Analytics.tsx - Dashboard with metrics

Backend Files

main.py - FastAPI server with all endpoints
config.py - Configuration from environment variables

State Management

reviewStore.ts - Zustand store for UI state
useReview.ts - Custom hook for review logic
api.ts - Axios API client with streaming

Styling

globals.css - Tailwind CSS + animations
tailwind.config.js - Tailwind configuration
postcss.config.js - PostCSS plugins

Configuration

.env - Your API keys and settings
requirements.txt - Python package versions
package.json - Node.js dependencies
docker-compose.yml - Container orchestration

🚀 Getting Started by Role

I'm a Developer

Read README.md for overview
Follow QUICK_START.md to run locally
Check ARCHITECTURE.md for system design
Explore frontend/src/ for React code
Check backend/app/main.py for API logic

I'm DevOps

Review SETUP_GUIDE.md for deployment
Check docker-compose.yml for containers
Read ARCHITECTURE.md for infrastructure
Configure .env for your environment
Use Dockerfile files for custom builds

I'm a Data Scientist

Check PROJECT_SUMMARY.md for ML strategy
Review backend/app/main.py for Groq integration
Check ARCHITECTURE.md for data flow
Explore requirements.txt for ML packages

I'm a Product Manager

Read README.md for features
Check COMPLETION_REPORT.md for status
Review ARCHITECTURE.md for capabilities
See PROJECT_SUMMARY.md for roadmap

📖 Documentation by Topic

Getting Started

Quick Setup: QUICK_START.md
Detailed Setup: SETUP_GUIDE.md
Project Overview: README.md

Understanding the System

Architecture: ARCHITECTURE.md
Implementation: PROJECT_SUMMARY.md
Completion Status: COMPLETION_REPORT.md

Using the Application

API Endpoints: ARCHITECTURE.md (API Specifications section)
Running Locally: QUICK_START.md
Deployment: SETUP_GUIDE.md (sections 8-10)

Development

Frontend Code: frontend/src/
Backend Code: backend/app/main.py
Configuration: .env and config files

🔍 Finding Things

I need to...

...understand the architecture

→ ARCHITECTURE.md - Complete system design with diagrams

...deploy to production

→ SETUP_GUIDE.md - Sections on cloud deployment

...modify the code

→ frontend/src/ or backend/app/main.py directly

...change configuration

→ Edit .env file (see .env.example for template)

...troubleshoot an error

→ SETUP_GUIDE.md - Troubleshooting section

...understand the API

→ Run app and visit http://localhost:8000/docs

...see what's been built

→ COMPLETION_REPORT.md - Complete summary

...learn the tech stack

→ README.md - Technology section

...add a new feature

→ ARCHITECTURE.md - Scaling strategy section

...understand the data flow

→ ARCHITECTURE.md - Request/Response Flow section

📚 File Reading Order

First Time Setup

README.md (understand what it is)
QUICK_START.md (get it running)
Open http://localhost:5173 in browser
Submit code for review!

Understanding the Code

ARCHITECTURE.md (see the big picture)
PROJECT_SUMMARY.md (understand the plan)
frontend/src/App.tsx (see main component)
backend/app/main.py (see API implementation)

Advanced Usage

SETUP_GUIDE.md (deployment details)
docker-compose.yml (infrastructure)
requirements.txt (dependencies)
ARCHITECTURE.md (scaling strategies)

🎓 Learning Resources

React/TypeScript

App.tsx - Main component structure
components/ - Component examples
hooks/useReview.ts - Custom hook pattern
store/reviewStore.ts - State management

FastAPI/Python

main.py - API routing and integration
config.py - Configuration management
Sample code shows async/await patterns

Docker

docker-compose.yml - Multi-container setup
Dockerfile files - Image definitions
Shows networking, volumes, environment

Tailwind CSS

globals.css - Utility-first examples
tailwind.config.js - Custom configuration
Components use Tailwind classes

🔑 Key Concepts

Frontend Architecture

User → React Component → Zustand Store → API Client → Backend
↑                                          ↓
└──── SSE EventSource ← StreamResponse ←──┘

Backend Architecture

FastAPI Endpoint → Config → Groq API → Response → Frontend
                        ↓
                   MongoDB (future)

Deployment

Docker Compose → MongoDB + FastAPI + React → Browser

✅ Checklist for New Users

📞 Getting Help

Issue Categories

Can't start the app? → SETUP_GUIDE.md → Troubleshooting section

Don't understand architecture? → ARCHITECTURE.md → System Architecture Diagram

Want to deploy? → SETUP_GUIDE.md → Production Deployment

Need API documentation? → http://localhost:8000/docs (when running)

Looking for a specific file? → Use file search or check the structure above

🚀 Next Steps

Start Local: Follow QUICK_START.md
Understand: Read ARCHITECTURE.md
Explore: Open http://localhost:5173
Deploy: Follow SETUP_GUIDE.md
Extend: Modify code in frontend/src or backend/app

📊 Document Statistics

Document	Purpose	Length	Read Time
README.md	Project overview	400 lines	10 min
QUICK_START.md	5-minute setup	400 lines	5 min
SETUP_GUIDE.md	Detailed installation	600 lines	15 min
ARCHITECTURE.md	System design	500 lines	15 min
PROJECT_SUMMARY.md	Implementation plan	400 lines	10 min
COMPLETION_REPORT.md	Project completion	400 lines	10 min

Total Documentation: 2,700+ lines

🎯 Success Criteria

You'll know you're successful when:

✅ docker-compose up -d runs without errors ✅ http://localhost:5173 opens in browser ✅ You can submit code and get a review ✅ Results display in real-time ✅ History and Analytics tabs work ✅ API docs are available at /docs

📝 File Naming Convention

Markdown Files:      .md (documentation)
Frontend:            .tsx, .ts (React TypeScript)
Backend:             .py (Python)
Config:              .json, .js, .env, .yml
Docker:              Dockerfile, docker-compose.yml

🔐 Security & Best Practices

Never commit .env - It's in .gitignore
Use .env.example - As template for team
Keep API keys safe - Environment variables only
Docker isolation - Services in containers
Input validation - All endpoints validate

🗺️ You Are Here

This INDEX.md file is your navigation guide through the entire CodeMentor AI project.

Start with README.md or QUICK_START.md and come back here if you need to find something!

Happy exploring! 🚀

FilesExpand file tree

INDEX.md

Latest commit

History