Add documentation explaining project structure

[hyochan]

Original Content

Please explain project structure!

---

Description

The project structure is not well documented. It would be helpful to have clear documentation explaining:

• The purpose of each directory
• How the different components interact
• Where to find specific functionality
• Best practices for navigating and contributing to the codebase

Proposed Solution

Add a comprehensive PROJECT_STRUCTURE.md or similar documentation file that outlines the project organization and helps new contributors understand the codebase layout.

---

🤖 Formatted by gitdog.dev

[gitdogdev[bot]]

Suggested Implementation:

Create PROJECT_STRUCTURE.md covering:

• app/[lang]/ - Next.js App Router pages with [lang] dynamic routing for i18n. Contains home, leaderboards, stats, and sign-in pages with nested components.
• pages/api/ - REST API endpoints: github-stats, github-trophies, leaderboards, news-letter, plugins, recent-users, proxy-github-stats.
• server/ - Backend: Supabase clients, GitHub service integration, plugin system for stats calculations (earth, fire, gold, people, tree, water), SVG generation, trophy logic.
• src/ - Shared code: components (Auth/Locale/Root providers), utilities (i18n, storage, theme), hooks, services, types, and API fetches.
• prisma/ - Database schema and seed data.

Add a quick start section showing where to find: authentication (app/auth, src/components/AuthProvider), GitHub integration (server/services/githubService), UI components (app/[lang]/(common)), and API routes (pages/api).

---

🤖 Generated by gitdog.dev · Have more questions? Tag @gitdog and let me know!

[hyochan]

@GitDog Why do you use nextjs?

[gitdogdev[bot]]

Next.js was chosen for this project because it provides a full-stack framework that handles both frontend and backend needs efficiently. The project uses Next.js with React Server Components, Supabase for database/auth, and needs to serve both a web UI (stats dashboard) and API endpoints for generating GitHub stats badges/images. Next.js App Router (with [lang] dynamic routing for i18n) handles the multi-language pages, while pages/api/ routes serve the REST API endpoints. It also includes PWA support (via next-pwa in next.config.js) for offline capability. This unified approach simplifies deployment (hosted on Vercel), enables server-side rendering for SEO, and keeps frontend and backend code in one repository with shared types and utilities.

---

🤖 Generated by gitdog.dev · Have more questions? Tag @gitdog and let me know!