GitBoarding

GitBoarding preview

Stack

Next.js, FastAPI, Python, TypeScript, Three.js, OpenAI, ChromaDB

Background

Onboarding to a new codebase is one of the slowest parts of joining a project. Reading through files and folders and trying to understand how each part of the codebase works can often take hours, if not days. GitBoarding is a project I built with the hope of reducing that time by providing a faster, more visual way to understand how a codebase is structured and allowing users to ask questions about a repository as if they were speaking to a person.

Overview

GitBoarding takes any GitHub repository and turns it into an interactive 3D map of the codebase. It looks at how files import and connect to one another, then makes the more important files stand out so users can quickly understand where to start. Alongside the visualisation, there is also a chat feature that lets users ask questions about the repository and get answers based on the actual source code. I also containerized the backend with Docker and set up automated deployment through GitHub Actions.

Demo