Transform cold, static code into a living, breathing story you can see and hear.
Demo โข Features โข Tech Stack โข Installation โข Usage
- ๐ก Inspiration
- โ What it Does
- โจ Features
- ๐ ๏ธ How We Built It
- ๐๏ธ Tech Stack
- ๐ฏ Architecture
- ๐ฉ Challenges We Faced
- ๐ง What We Learned
- ๐ Installation
- ๐ฎ What's Next
- ๐ฅ Team
- ๐ License
Every developer has faced the "Wall of Code" nightmare: joining a massive legacy project with zero documentation and thousands of interconnected functions. Hours turn into days as you trace function calls, decipher cryptic variable names, and try to understand the mental model of developers who left years ago.
We realized that while we have powerful tools to write code, we lack intuitive tools to experience it.
Traditional documentation is:
- ๐ Often outdated or non-existent
- ๐ฅฑ Boring to read and hard to maintain
- ๐งฉ Disconnected from the actual code structure
- ๐ซ Inaccessible for visual or auditory learners
We built Nexo to turn cold, static text into a living, breathing story that you can both see and hearโa revolutionary approach to code onboarding that reduces weeks of confusion into minutes of clarity.
Nexo is an AI-powered code documentation and visualization platform that transforms any codebase into an interactive, multi-modal learning experience.
-
๐ Paste a Repository URL
Simply provide a GitHub/GitLab link to any project. -
๐ง AI Analysis
Our Gemini-powered engine analyzes the code structure, dependencies, and logic flow. -
๐ Visual Flow Generation
See your codebase as an interactive dependency graph with modules, functions, and their relationships. -
๐๏ธ Audio Narration
Listen to AI-generated "Code Podcasts" that explain each file's purpose, logic, and integration pointsโperfect for commuting, exercising, or simply giving your eyes a rest. -
๐๏ธ Instant Access
Once analyzed, the documentation is cached and available instantly for your entire team.
-
๐ Smart Analysis
Deep code understanding powered by Gemini API, extracting functions, classes, and their relationships. -
๐ง Code Podcasts
AI-narrated explanations of code logic in natural, human languageโlearn on the go. -
๐ฑ Responsive Design
Works seamlessly on desktop, tablet, and mobile devices.
-
๐ Zero Configuration
No SDKs to install, no config files to writeโjust paste and analyze. -
๐ Secure & Private
Your code is processed securely and never stored permanently without permission. -
๐ฅ Team Collaboration
Share generated documentation links with your entire team instantly. -
๐ Usage Analytics
Track which parts of your codebase need better documentation based on view counts.
Nexo is a sophisticated orchestration of cutting-edge AI, cloud infrastructure, and modern web technologies:
The Gemini API acts as our senior architect, performing deep static analysis to:
- Extract function signatures, classes, and imports
- Map dependencies and call graphs
- Generate human-readable summaries of code logic
- Structure data into JSON-friendly formats for visualization
ElevenLabs transforms technical analysis into natural narration:
- Converts code summaries into conversational scripts
- Generates high-quality, human-like voice audio
- Creates segmented "chapters" for different modules
- Optimizes audio compression for web delivery
- MongoDB Atlas: Stores graph metadata, audio links, and analysis results
- Caching Strategy: Once analyzed, subsequent loads are near-instantaneous
- Scalable Schema: Optimized for quick lookups and graph traversal queries
- React 18 + TypeScript: Type-safe, component-based architecture
- Vite: Lightning-fast development and optimized production builds
- D3.js/Cytoscape: Interactive graph visualizations with physics simulations
- CSS Modules: Scoped styling for maintainable design
- React 18 with Hooks and Context API
- TypeScript for type safety
- Vite for blazing-fast builds
- CSS Modules for scoped styling
- FastAPI for high-performance REST APIs
- Pydantic for data validation
- JWT Authentication for secure user sessions
- Google Gemini API for code analysis
- ElevenLabs API for voice synthesis
- MongoDB Atlas for database
- Docker/Podman for containerization
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ User Browser โ
โ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโ โ
โ โ React โ โ Graph โ โ Audio Player โ โ
โ โ App โ โ Renderer โ โ (ElevenLabs) โ โ
โ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ
โ HTTPS
โผ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Cloudflare Workers (Edge Layer) โ
โ โข Static Asset Delivery โข API Proxying โข Caching โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ
โ
โโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโ
โ โ
โผ โผ
โโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโ
โ FastAPI Server โ โ MongoDB Atlas โ
โ (Vultr VM) โโโโโโโโโโโโโโโโโโโบโ (Database) โ
โ โ โ โ
โ โโโโโโโโโโโโโโ โ โ โข Graph Data โ
โ โ Gemini โ โ โ โข Audio URLs โ
โ โ API โ โ โ โข User Data โ
โ โโโโโโโโโโโโโโ โ โ โข Cache Layer โ
โ โ โโโโโโโโโโโโโโโโโโโโ
โ โโโโโโโโโโโโโโ โ
โ โ ElevenLabs โ โ
โ โ API โ โ
โ โโโโโโโโโโโโโโ โ
โโโโโโโโโโโโโโโโโโโโ
Problem: Large codebases create overwhelming "spaghetti code" visualizations with thousands of interconnected nodes.
Solution:
- Implemented AI-driven clustering to group related modules
- Created hierarchical views with drill-down capabilities
- Added intelligent filtering to show only relevant dependencies
- Used force-directed layouts with customizable physics
Problem: Codebases often exceed the token limits of AI models (even Gemini's extended context).
Solution:
- Developed smart chunking logic that preserves semantic relationships
- Prioritized entry points and high-traffic functions
- Implemented incremental analysis for large repositories
- Created a summary-first approach: analyze file structure before diving into details
Problem: ElevenLabs produces high-quality audio but has processing latency that could ruin UX.
Solution:
- Implemented asynchronous job queues with progress indicators
- Pre-generated audio for popular repositories
- Offered text-to-speech fallback for instant (lower quality) narration
- Cached all generated audio in MongoDB and CDN
Building Nexo taught us the transformative power of Multi-Modal Onboarding.
We discovered that combining visual metrics with auditory explanations significantly reduces cognitive load compared to reading raw text. The formula we observed:
Where:
-
$L_c$ = Cognitive Load (mental effort required) -
$T_x$ = Complexity of raw text documentation
Key Insights:
- ๐จ Visual Learning: 65% of people are visual learnersโgraphs leverage spatial memory
- ๐ง Auditory Reinforcement: Hearing explanations while seeing structure creates dual encoding
- โก Reduced Context Switching: No need to jump between filesโsee the big picture first
- ๐ง Pattern Recognition: Visual patterns reveal architectural insights text can't convey
-
Prompt Engineering is an Art:
We iterated dozens of times to ensure Gemini outputs strictly valid JSON for real-time rendering. -
AI Hallucination Mitigation:
Validate all AI outputs against the actual code structureโnever trust blindly. -
Caching is King:
A well-designed cache strategy makes a 30-second analysis feel instant on repeat visits. -
UX > Features:
We cut 40% of planned features to polish the core experienceโless is more.
- Node.js 18+ and npm/yarn
- Python 3.11+
- Docker or Podman
- MongoDB instance (or MongoDB Atlas account)
- API Keys:
- Google Gemini API
- ElevenLabs API
git clone https://github.com/Hacktown-BSB/Nexo.git
cd Nexo
cd server
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Create .env file
cat > .env << EOF
MONGODB_URI=your_mongodb_connection_string
GEMINI_API_KEY=your_gemini_api_key
ELEVENLABS_API_KEY=your_elevenlabs_api_key
JWT_SECRET=your_secret_key
EOF
# Run the server
uvicorn main:app --reload --host 0.0.0.0 --port 8000
cd client
# Install dependencies
npm install
# Create .env file
cat > .env << EOF
VITE_API_URL=http://localhost:8000
EOF
# Run development server
npm run dev
# From project root
docker-compose up --build
# Or with Podman
podman-compose up --build
The application will be available at:
- Frontend:
http://localhost:5173 - Backend API:
http://localhost:8000 - API Docs:
http://localhost:8000/docs
-
๐ IDE Integrations
VS Code, JetBrains, and Vim plugins for in-editor visualizations -
๐ Auto-Generated Docs
Export to Markdown, HTML, or PDF with embedded graphs -
๐ฅ Collaboration Features
Annotate graphs, leave comments, track team onboarding progress
This project is licensed under the MIT License - see the LICENSE file for details.
- Google Gemini for powerful code analysis capabilities
- ElevenLabs for natural-sounding voice synthesis
- MongoDB Atlas for scalable database solutions
- The open-source community for inspiration and tools
Star โญ this repo if you find it useful!
Made with ๐ง and ๐๏ธ by developers, for developers.
Demo โข Features โข Tech Stack โข Installation
- ๐ก Inspiration
- โ What it Does
- โจ Features
- ๐ ๏ธ How We Built It
- ๐๏ธ Tech Stack
- ๐ฏ Architecture
- ๐ฉ Challenges We Faced
- ๐ง What We Learned
- ๐ Installation
- ๐ฎ What's Next
- ๐ฅ Team
- ๐ License
Every developer has faced the "Wall of Code" nightmare: joining a massive legacy project with zero documentation and thousands of interconnected functions. Hours turn into days as you trace function calls, decipher cryptic variable names, and try to understand the mental model of developers who left years ago.
We realized that while we have powerful tools to write code, we lack intuitive tools to experience it.
Traditional documentation is:
- ๐ Often outdated or non-existent
- ๐ฅฑ Boring to read and hard to maintain
- ๐งฉ Disconnected from the actual code structure
- ๐ซ Inaccessible for visual or auditory learners
We built Nexo to turn cold, static text into a living, breathing story that you can both see and hearโa revolutionary approach to code onboarding that reduces weeks of confusion into minutes of clarity.
Nexo is an AI-powered code documentation and visualization platform that transforms any codebase into an interactive, multi-modal learning experience.
-
๐ Paste a Repository URL
Simply provide a GitHub/GitLab link to any project. -
๐ง AI Analysis
Our Gemini-powered engine analyzes the code structure, dependencies, and logic flow. -
๐ Visual Flow Generation
See your codebase as an interactive dependency graph with modules, functions, and their relationships. -
๐๏ธ Audio Narration
Listen to AI-generated "Code Podcasts" that explain each file's purpose, logic, and integration pointsโperfect for commuting, exercising, or simply giving your eyes a rest. -
๐๏ธ Instant Access
Once analyzed, the documentation is cached and available instantly for your entire team.
-
๐ Smart Analysis
Deep code understanding powered by Gemini API, extracting functions, classes, and their relationships. -
๐ง Code Podcasts
AI-narrated explanations of code logic in natural, human languageโlearn on the go. -
๐ฑ Responsive Design
Works seamlessly on desktop, tablet, and mobile devices.
-
๐ Zero Configuration
No SDKs to install, no config files to writeโjust paste and analyze. -
๐ Secure & Private
Your code is processed securely and never stored permanently without permission. -
๐ฅ Team Collaboration
Share generated documentation links with your entire team instantly. -
๐ Usage Analytics
Track which parts of your codebase need better documentation based on view counts.
Nexo is a sophisticated orchestration of cutting-edge AI, cloud infrastructure, and modern web technologies:
The Gemini API acts as our senior architect, performing deep static analysis to:
- Extract function signatures, classes, and imports
- Map dependencies and call graphs
- Generate human-readable summaries of code logic
- Structure data into JSON-friendly formats for visualization
ElevenLabs transforms technical analysis into natural narration:
- Converts code summaries into conversational scripts
- Generates high-quality, human-like voice audio
- Creates segmented "chapters" for different modules
- Optimizes audio compression for web delivery
- MongoDB Atlas: Stores graph metadata, audio links, and analysis results
- Caching Strategy: Once analyzed, subsequent loads are near-instantaneous
- Scalable Schema: Optimized for quick lookups and graph traversal queries
- React 18 + TypeScript: Type-safe, component-based architecture
- Vite: Lightning-fast development and optimized production builds
- D3.js/Cytoscape: Interactive graph visualizations with physics simulations
- CSS Modules: Scoped styling for maintainable design
- React 18 with Hooks and Context API
- TypeScript for type safety
- Vite for blazing-fast builds
- CSS Modules for scoped styling
- FastAPI for high-performance REST APIs
- Pydantic for data validation
- JWT Authentication for secure user sessions
- Google Gemini API for code analysis
- ElevenLabs API for voice synthesis
- MongoDB Atlas for database
- Docker/Podman for containerization
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ User Browser โ
โ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโ โ
โ โ React โ โ Graph โ โ Audio Player โ โ
โ โ App โ โ Renderer โ โ (ElevenLabs) โ โ
โ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ
โ HTTPS
โผ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Cloudflare Workers (Edge Layer) โ
โ โข Static Asset Delivery โข API Proxying โข Caching โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ
โ
โโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโ
โ โ
โผ โผ
โโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโ
โ FastAPI Server โ โ MongoDB Atlas โ
โ (Vultr VM) โโโโโโโโโโโโโโโโโโโบโ (Database) โ
โ โ โ โ
โ โโโโโโโโโโโโโโ โ โ โข Graph Data โ
โ โ Gemini โ โ โ โข Audio URLs โ
โ โ API โ โ โ โข User Data โ
โ โโโโโโโโโโโโโโ โ โ โข Cache Layer โ
โ โ โโโโโโโโโโโโโโโโโโโโ
โ โโโโโโโโโโโโโโ โ
โ โ ElevenLabs โ โ
โ โ API โ โ
โ โโโโโโโโโโโโโโ โ
โโโโโโโโโโโโโโโโโโโโ
Problem: Large codebases create overwhelming "spaghetti code" visualizations with thousands of interconnected nodes.
Solution:
- Implemented AI-driven clustering to group related modules
- Created hierarchical views with drill-down capabilities
- Added intelligent filtering to show only relevant dependencies
- Used force-directed layouts with customizable physics
Problem: Codebases often exceed the token limits of AI models (even Gemini's extended context).
Solution:
- Developed smart chunking logic that preserves semantic relationships
- Prioritized entry points and high-traffic functions
- Implemented incremental analysis for large repositories
- Created a summary-first approach: analyze file structure before diving into details
Problem: ElevenLabs produces high-quality audio but has processing latency that could ruin UX.
Solution:
- Implemented asynchronous job queues with progress indicators
- Pre-generated audio for popular repositories
- Offered text-to-speech fallback for instant (lower quality) narration
- Cached all generated audio in MongoDB and CDN
Building Nexo taught us the transformative power of Multi-Modal Onboarding.
We discovered that combining visual metrics with auditory explanations significantly reduces cognitive load compared to reading raw text. The formula we observed:
Where:
-
$L_c$ = Cognitive Load (mental effort required) -
$T_x$ = Complexity of raw text documentation
Key Insights:
- ๐จ Visual Learning: 65% of people are visual learnersโgraphs leverage spatial memory
- ๐ง Auditory Reinforcement: Hearing explanations while seeing structure creates dual encoding
- โก Reduced Context Switching: No need to jump between filesโsee the big picture first
- ๐ง Pattern Recognition: Visual patterns reveal architectural insights text can't convey
-
Prompt Engineering is an Art:
We iterated dozens of times to ensure Gemini outputs strictly valid JSON for real-time rendering. -
AI Hallucination Mitigation:
Validate all AI outputs against the actual code structureโnever trust blindly. -
Caching is King:
A well-designed cache strategy makes a 30-second analysis feel instant on repeat visits. -
UX > Features:
We cut 40% of planned features to polish the core experienceโless is more.
- Node.js 18+ and npm/yarn
- Python 3.11+
- Docker or Podman
- MongoDB instance (or MongoDB Atlas account)
- API Keys:
- Google Gemini API
- ElevenLabs API
git clone https://github.com/Hacktown-BSB/Nexo.git
cd Nexo
cd server
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Create .env file
cat > .env << EOF
MONGODB_URI=your_mongodb_connection_string
GEMINI_API_KEY=your_gemini_api_key
ELEVENLABS_API_KEY=your_elevenlabs_api_key
JWT_SECRET=your_secret_key
EOF
# Run the server
uvicorn main:app --reload --host 0.0.0.0 --port 8000
cd client
# Install dependencies
npm install
# Create .env file
cat > .env << EOF
VITE_API_URL=http://localhost:8000
EOF
# Run development server
npm run dev
# From project root
docker-compose up --build
# Or with Podman
podman-compose up --build
The application will be available at:
- Frontend:
http://localhost:5173 - Backend API:
http://localhost:8000 - API Docs:
http://localhost:8000/docs
-
๐ IDE Integrations
VS Code, JetBrains, and Vim plugins for in-editor visualizations -
๐ Auto-Generated Docs
Export to Markdown, HTML, or PDF with embedded graphs -
๐ฅ Collaboration Features
Annotate graphs, leave comments, track team onboarding progress
This project is licensed under the MIT License - see the LICENSE file for details.
- Google Gemini for powerful code analysis capabilities
- ElevenLabs for natural-sounding voice synthesis
- MongoDB Atlas for scalable database solutions
- The open-source community for inspiration and tools
Star โญ this repo if you find it useful!
Made with ๐ง and ๐๏ธ by developers, for developers.