How rishikendai/octoviz works
Project type and purpose
– Octoviz is a full-stack, single-page application that analyzes and visualizes GitHub user profile data.
– The frontend is a React/TypeScript SPA built with Vite, and the backend is a Go (Gin) HTTP API that proxies requests to GitHub’s public API.
File structure
– Top level: two peer directories, “frontend” and “server.”
– frontend/ contains:
• Vite build and config files (vite.config.ts, tsconfig.json, vercel.json)
– server/ contains:
• main.go entrypoint, go.mod/go.sum, .air.toml for live reload
• api/v1/controllers/dashboard – HTTP handlers, helpers, types
• api/v1/routes – route definitions
• middleware – CORS, security headers, error handling, request decoding
• pkg/config – environment configuration loader
• pkg/config/response – uniform API response builder
README for additional insights
– User enters GitHub URL in frontend → frontend components (Search, ProfileCard, ContributionGraph, TechStack, TopRepo) render data.
– Frontend calls backend endpoints for data; backend uses GitHub Personal Access Token to fetch data and returns JSON.