2.3 KiB
2.3 KiB
Project Scaffolding Rules
The generator must use official CLI tools to create base project structures.
The AI must not manually generate the entire project skeleton (e.g. by writing all config files and folder structure by hand). Using the CLI reduces errors and ensures compatibility with current tool versions.
Backend Scaffolding
Use NestJS CLI.
Command
npx @nestjs/cli@10.3.2 new server --package-manager npm --skip-git
Rules
- Project directory must be
server. - TypeScript must be used (default for Nest CLI).
- npm must be the package manager (
--package-manager npm). - Git initialization must be skipped (
--skip-git).
After scaffolding — install required dependencies
Run from the server directory:
npm install @prisma/client
npm install prisma --save-dev
npm install @nestjs/config
Frontend Scaffolding
Use Vite CLI.
Command
npm create vite@5.2.0 client -- --template react-ts
Rules
- Project directory must be
client. - React + TypeScript template must be used (
--template react-ts).
After scaffolding — install required dependencies
Run from the client directory:
npm install react-admin
npm install ra-data-simple-rest
npm install @mui/material @emotion/react @emotion/styled
Scaffolding Strategy
Generation pipeline order:
- Parse DSL — Read domain, DTO, API, and UI DSL files.
- Run CLI scaffolding — Create
serverwith NestJS CLI andclientwith Vite CLI; install dependencies as above. - Code generation — Generate Prisma schema, NestJS modules/DTOs/PrismaService, and React Admin resources.
- Runtime infrastructure — Generate
.env,.env.example, package lifecycle scripts, and runtime config files. - Database runtime — Generate
docker-compose.ymlin project root with PostgreSQL service (postgres, imagepostgres:16, port5432:5432). - Migration — Apply schema with
npx prisma migrate dev. - Seed — Populate minimal development data with
npx prisma db seed. - Validation — Run checks from
generation/post-generation-validation.md.
Scaffolding (steps 1–2) must be done with the CLI; steps 3–8 are generated from the DSL and project docs.