50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
# Project Overview
|
|
|
|
This is to kick start a web project with nextjs as frontend and go server as backend.
|
|
|
|
## Structure
|
|
|
|
```
|
|
starter/
|
|
├── .env
|
|
├── .env.dev
|
|
├── sh/ # Shell scripts for development and deployment automation
|
|
│ ├── dev.sh
|
|
│ └── prod.sh
|
|
├── frontend/
|
|
│ ├── public/
|
|
│ ├── src/
|
|
│ │ └── app/
|
|
│ │ ├── layout.tsx
|
|
│ │ ├── page.tsx
|
|
│ │ ├── favicon.ico
|
|
│ │ └── globals.css
|
|
│ ├── Dockerfile
|
|
│ ├── package.json
|
|
│ └── ...
|
|
└── backend/
|
|
├── internal/
|
|
│ └── ...
|
|
├── main.go
|
|
├── go.mod
|
|
├── go.sum
|
|
└── ...
|
|
```
|
|
|
|
## 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.
|
|
|
|
## Tooling Versions And Configurations
|
|
|
|
- Node.js: v22.15.0
|
|
- npm&npx: 10.9.2
|
|
- Go: 1.23.9
|
|
- API prefix: `/service/`
|
|
- Next.js 15.3.2 (App Router, Turbopack enabled, Import alias: `@/*`)
|
|
- Logto 1.27.0
|
|
|
|
## Rules
|
|
|
|
- Frontend and backend should communicate with standard JSON.
|