Objective:
Develop a comprehensive guide to the project structure to help new developers onboard quickly and effectively.
Steps:
- Overview of the Project:
Provide a high-level description of the project's purpose and architecture.
Explain how the project is organized into workspaces (e.g., apps, packages).
- Detailed Breakdown of Key Directories:
apps/:
Describe the main web application and its components.
Include information about pages, components, and hooks.
packages/:
Explain shared utilities, styles, and any other reusable modules.
config/:
Detail configurations (e.g., ESLint, Biome, TailwindCSS).
- Scripts and Commands:
List and explain key scripts like build, dev, and db:migrate.
Provide examples of how to use each script during development.
Show how modules, components, and services interact.
Include a diagram or chart if possible.
- Development Guidelines:
Emphasize coding conventions and standards.
Link to the Biome formatting and linting rules.
- Testing Directory and Standards:
Explain how to write and organize tests (unit, integration, E2E).
Provide examples of existing tests and how to run them.
- Include Visual Aids:
Add file structure snippets or flow diagrams for clarity.
Use examples to illustrate concepts.
Objective:
Develop a comprehensive guide to the project structure to help new developers onboard quickly and effectively.
Steps:
Provide a high-level description of the project's purpose and architecture.
Explain how the project is organized into workspaces (e.g., apps, packages).
apps/:
Describe the main web application and its components.
Include information about pages, components, and hooks.
packages/:
Explain shared utilities, styles, and any other reusable modules.
config/:
Detail configurations (e.g., ESLint, Biome, TailwindCSS).
List and explain key scripts like build, dev, and db:migrate.
Provide examples of how to use each script during development.
Show how modules, components, and services interact.
Include a diagram or chart if possible.
Emphasize coding conventions and standards.
Link to the Biome formatting and linting rules.
Explain how to write and organize tests (unit, integration, E2E).
Provide examples of existing tests and how to run them.
Add file structure snippets or flow diagrams for clarity.
Use examples to illustrate concepts.