Codebase Analytics

A web application that provides comprehensive analytics for GitHub repositories. The project combines a Modal-based FastAPI backend with a Next.js frontend to provide efficient and beautiful codebase metrics.

Users submit a GitHub repository through the frontend. The Modal API processes the request using custom implementations of the metric calculations using the codegen library. Results are returned to the frontend for display.

How it Works

Backend (Modal API)

The backend is built using Modal and FastAPI, providing a serverless API endpoint for code research.

There is a main API endpoint that handles codebase analysis requests. It uses the codegen library for these operations.

The following metrics are calculated:

• Maintainability Index: Measures the maintainability of the codebase, on a scale of 0-100.
• Cyclomatic Complexity: Measures the complexity of the codebase. Higher values indicate more complex code.
• Halstead Volume: Quantifies the information content in the code based on operators and operands. Higher values indicate more complex code.
• Depth of Inheritance: Measures the depth of inheritance of the codebase.
• Lines of Code (LOC, SLOC, LLOC): Measures the number of lines of code in the codebase. LOC, SLOC, and LLOC represent the total, source, and logical lines of code, respectively.
• Comment Density: Measures the density of comments in the codebase, given as a percentage of the total lines of code. More comments can indicate better documentation.

complexity = calculate_cyclomatic_complexity(func)
operators, operands = get_operators_and_operands(func)
volume, _, _, _, _ = calculate_halstead_volume(operators, operands)
loc = len(func.code_block.source.splitlines())
mi_score = calculate_maintainability_index(volume, complexity, loc)

Monthly commit history is also pulled from the GitHub API and displayed in a chart.

The codebase is also graded on a scale of A-F for overall quality and maintainability. The complexity of the codebase is also given a qualitative rank.

Frontend (Next.js)

The frontend provides an interface for users to submit a GitHub repository and research query. The components come from the shadcn/ui library. This triggers the Modal API to perform the code research and returns the results to the frontend.

Getting Started

1. Set up environment variables in an .env file:

   OPENAI_API_KEY=your_key_here
   

2. Deploy or serve the Modal API:

   modal serve backend/api.py

   modal serve runs the API locally for development, creating a temporary endpoint that's active only while the command is running.

   modal deploy backend/api.py

   modal deploy creates a persistent Modal app and deploys the FastAPI app to it, generating a permanent API endpoint.

   After deployment, you'll need to update the API endpoint in the frontend configuration to point to your deployed Modal app URL.

3. Run the Next.js frontend:

   cd frontend
   npm install
   npm run dev

Learn More

More information about the codegen library can be found here.