This file is the primary map of the repository. Use this to quickly locate relevant folders and configurations.
| File | Purpose |
|---|---|
| README.md | Project overview, setup instructions, and primary context. |
| issues.md | Current known bugs and backend limitations. |
| AGENTS.md | Active agent configurations and methodologies. |
| PROJECT_RULES.md | Project-specific rules and guidelines. |
| CHANGELOG.md | Record of version changes and feature additions. |
Each directory contains a specific domain of the application and has its own README.md file detailing its contents and architecture.
| Directory | Purpose | Documentation |
|---|---|---|
app/ |
Next.js App Router UI, pages, and route logic. | app/README.md |
components/ |
Reusable UI components (MUI v7), layouts, and auth wrappers. | components/README.md |
lib/ |
API clients, configurations, theme definitions, and utility scripts. | lib/README.md |
docs/ |
Deep-dive technical manuals, architecture guidelines, and logic specs. | docs/README.md |
types/ |
Global TypeScript type declarations and interfaces. | types/README.md |
scripts/ |
Standalone scripts for maintenance, cleanup, or data fetching. | scripts/README.md |
public/ |
Static media, icons, and assets. | public/README.md |
tests/ |
Playwright E2E and Vitest unit testing configurations and suites. | tests/README.md |
test-data/ |
Mock JSON responses and static structure definitions for tests. | test-data/README.md |
legacy/ |
Externa or outdated dependencies, previous implementation phases, and legacy codebase artifacts. | legacy/README.md |
| Directory | Purpose |
|---|---|
.gsd/ |
Project roadmap, current state, and specific agent tasks. |
.agent/ |
Skills, workflows, and rules for AI agents. |
Please navigate to individual folder README.md files for deeper domain information.