快速开始
环境要求
- Node.js 22+
- Docker & Docker Compose(可选,用于本地数据库)
- npm
安装步骤
1. 安装依赖
# 在项目根目录
npm ci
2. 配置环境变量
cp .env.example .env
编辑根目录 .env,填入必要的配置。详见 环境变量。
3. 启动数据库和缓存
本地 Docker 启动:
cd docker/dev
cp .env.example .env
# 编辑 .env 修改数据库和缓存配置
docker compose up -d
也可以使用在线服务(跳过 Docker):
| 服务 | 在线平台 |
|---|---|
| PostgreSQL | Supabase、Neon、Railway |
| Valkey / Redis | Upstash、Redis Cloud |
将连接串填入 .env 的 POSTGRES_CONNECTION_STRING 和 VALKEY_CONNECTION_STRING 即可。
4. 执行数据库迁移
npm run db:migrate
5. 启动开发服务
# 启动后端(终端 1)
npm run dev:api
# 启动前端(终端 2)
npm run dev:console
# 启动官网(终端 3,可选)
npm run dev:website
6. 创建管理员
# 先在前端注册一个账号,然后设置为管理员
npm run owner:set your@email.com
访问地址
| 服务 | 地址 |
|---|---|
| 前端 | http://localhost:5173 |
| 后端 | http://localhost:16888 |
| 官网 | http://localhost:4321 |