Explain This Codebase

Difficulty: MID | GoShip Challenge

The Problem

You join a new team. The codebase has 200 files, no documentation, and the person who built it left. You spend a week just figuring out where things are.

What to Build

Build a tool that generates a plain-English architecture guide from any GitHub repo.

Requirements

• Input a GitHub repo URL
• Analyze file structure, imports, and patterns
• Generate architecture overview (what each folder does)
• Data flow diagram (how things connect)
• Entry points and key files highlighted
• Getting started guide for new contributors

Bonus

• Interactive dependency graph
• API endpoint documentation
• Tech stack detection with version info

Quick Start

git clone https://github.com/GoShipTech/explain-this-codebase.git
cd explain-this-codebase
claude

Then tell Claude: "Read the CLAUDE.md and help me build this."

Use any tech stack. AI tools encouraged.

---

Part of the GoShip Shipyard.