Files
persionalBrand/README.md
T

83 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Personal Brand Miniapp
面向个体经营者的个人品牌小程序试点项目。当前首个试点为餐饮摊主与私厨服务。
## 工程结构
```text
apps/miniapp # 原生微信小程序
apps/admin # 管理后台
apps/api # API 服务
packages/types # 共享类型
packages/api-client
packages/validation
packages/config
packages/template-compiler # 构建时叠加 runtime、capability、template
packages/template-<key> # 独立行业 / 视觉模板包
packages/capability-<key> # 可选业务流程能力包
prisma/
docs/
prototype/
```
## 环境要求
- Node.js >= 20.18
- pnpm 9.15
- PostgreSQL(进入 API/数据库开发阶段时需要)
```bash
corepack enable
pnpm install
pnpm check
```
## 生成小程序模板
`apps/miniapp` 是运行时壳,不能直接作为完整小程序打开。使用模板编译器生成产物:
```bash
pnpm template:dev acheng-campus-food --brand default-brand
pnpm template:dev linjing-editorial --brand linjing-doors
```
产物位于 `dist/miniapp/<brand>/`,可直接用微信开发者工具打开。生产构建需额外提供 `--appid`、`--api https://...` 和 `--env prod`。
## 本地数据库
在有 Docker 的机器上执行:
```bash
cp .env.example .env
docker compose up -d postgres
docker compose ps
pnpm db:migrate
pnpm db:seed
```
确认数据库健康后,再启动 API:
```bash
pnpm --filter @personal-brand/api dev
```
停止数据库但保留数据:
```bash
docker compose stop postgres
```
停止并删除容器但保留数据卷:
```bash
docker compose down
```
删除容器和本地数据库数据(不可恢复):
```bash
docker compose down -v
```
`DATABASE_URL` 用于宿主机运行 API 时连接 `localhost`。如果以后把 API 也放进 Compose,连接地址应改为服务名 `postgres`,不能继续使用 `localhost`。