Repo Reader

Understand codebases in less time and with more fun

Comment

Inspiration

I was required to understand a codebase built and maintained over 2 years in 2 days. But i'm too lazy to just start reading through it and i didnt know where to start. Then i built Repo-reader to go through this codebase and give me a gamified walkthrough which i can finish in 15-25 minutes, saving me hours and keeping me lazy.

What it does

it clones the codebase you want to understand, uses the openAI llm to go through it understand the project structure, key files and entrypoints and all the important stuff, uses the LLM to structure a walkthrough guide to understanding this codebase with a couple questions to be sure you followed the guide and then you score points for following through and answering questions.

there is also a RAG system layered on top of it so you can ask questions about the codebase you are exploring.

How we built it

I built it using the flask + nextjs starter repo (python for backend, nextjs for frontend). Used LangGraph as the agent orchestration framework and LangSmith for monitoring the agent run. Using TiDB for the vector indexing and store.

Challenges we ran into

Light and Internet, hahaha. Also making the UI look sleek.

Accomplishments that we're proud of

it is working , yaayyyyyy!!!! I used it on my repo and learnt all i needed to know about the codebase in the smallest amount of time.

What we learned

I learnt how to build a solution for my problem , haha

What's next for Repo Reader

well, whats next would be to keep building new stuff, maintain repo-reader as is and possibly add new features if any comes to mind and to have fun.

Built With

Share this project:

Updates