Webapp-starter/AI_RULES.md
2025-05-07 10:03:24 +08:00

43 lines
1019 B
Markdown

# Project Overview
This is to kick start a web project with nextjs as frontend and go server as backend.
## Structure
```
fmc-writer/
├-- .env
├-- sh/
│ └── dev.sh
├── frontend/
│ ├── public/
│ ├── src/
│ │ ├── app/
│ │ └── components/
│ ├── package.json
│ └── ...
└── backend/
├── internal/
│ ├── handlers/
│ ├── middleware/
│ ├── models/
│ └── routes/
├── go.mod
├── go.sum
├── main.go
└── Makefile
```
## Configuration
All environmental variables should be managed in a centralized `.env` in the root dir of the repo, as we'll source them when running deploying scripts.
The only permitted way to test, build or run the project is through `sh/prod.sh`.
## Tooling Versions
- Node.js: v22.15.0
- npm&npx: 10.9.2
- Go: 1.21.5
- Next.js 15.3.2 (App Router, Turbopack enabled, Import alias: `@/*`)
- Logto 1.27.0