How habeeb-urrahman/githubanalyzer works
Project type and purpose
• This is a lightweight full-stack web application built with Flask (Python) on the backend and plain HTML/CSS/JS on the frontend.
• Its purpose is to accept a GitHub repository URL from the user, call the GitHub API, gather metadata and activity info (stars, forks, issues, contributors, commits), and display those insights in the browser.
File structure
• Top-level files:
• app.py – the Flask application entry point and controller logic
• requirements.txt – Python dependencies (Flask, requests, python-dotenv, etc.)
• index.html & style.css & script.js – likely legacy or direct static prototypes
• .gitignore, README.md
• Directories:
• /templates – Jinja2 templates (templates/index.html) used by Flask to render dynamic pages
• /static – served assets (static/script.js, static/style.css). These contain client-side behavior (AJAX calls, charting) and styles.
README for additional insights
• The README outlines features (metadata display, contributor stats, commit visualization), setup steps (virtual environment, .env with GITHUB_TOKEN), and startup (flask run).
• It implies use of environment configuration for API tokens, HTTP interaction with GitHub’s REST API, and data processing in Python before rendering.
Detailed capture of essential elements
• Don’t omit the role of the .env file and how secrets flow into the server
• Call out the static vs. template asset distinction
• That the server has no database—data comes fresh each request
• If using a chart library, group it under “Client visualization”
Summary instruction to the architect: