| .gitea/workflows | ||
| .workbuddy/memory | ||
| api | ||
| common | ||
| deploy | ||
| docs | ||
| hack | ||
| internal | ||
| manifest | ||
| resource | ||
| utility | ||
| .gitattributes | ||
| .gitignore | ||
| AGENTS.md | ||
| go.mod | ||
| go.sum | ||
| main.go | ||
| Makefile | ||
| PROJECT_STRUCTURE.md | ||
| README.MD | ||
Personal multi-client service
Layout
api → internal/controller → internal/service → internal/dao → internal/model(entity/do) is enforced. DTO and VO live in internal/model/dto and internal/model/vo; neither API types nor entities cross that boundary.
Database model generation
Run manifest/sql/001_core.sql on MySQL, set DB_DSN, then run:
gf gen dao -p internal -g default -gt -c
The command is intentionally the only source of internal/dao, internal/model/do, and internal/model/entity.
API isolation
/api/v1/*: user API, terminal header/body supportsmini,h5, andapp./admin/v1/*: admin API. Protected endpoints require both an admin access token and anX-Permissionidentifier.
Use GF_GCFG_FILE=config.dev.yaml (or config.test.yaml / config.prod.yaml) and set DB_DSN plus a strong JWT_SECRET before startup.
Local startup
- Terminal:
source .env.dev && go run main.go(.env.devis gitignored, holds local DSN + secret). - GoLand: run configuration
.run/service-dev.run.xml(project-level, auto-detected after reloading the project) already injectsGF_GCFG_FILE/DB_DSN/JWT_SECRET; pick it in the run dropdown. The file is gitignored because it contains the DB password.