安装与构建

学习如何在本机安装并启动 Canyon 社区版（Node.js 部署方式）。

1. 克隆仓库并进入 app

git clone https://github.com/canyon-project/canyon
cd canyon/app

2. 安装依赖

pnpm install

3. 配置环境变量

创建 app/.env（可从现有 .env 模板复制），至少包含：

DATABASE_URL=postgres://username:password@host:5432/dbname

4. 生成并执行建表 SQL

在 app 目录执行：

pnpm run migrate:sql

该命令会生成 app/schema.sql。然后手动执行该 SQL（示例）：

psql "postgres://username:password@host:5432/dbname" -f schema.sql

5. 启动服务

开发模式：

pnpm dev

生产模式（可选）：

pnpm build
pnpm start

6. 访问

默认访问地址：

• 开发模式（pnpm dev）：
  • 前端页面：http://localhost:3000
  • API：http://localhost:3000/api
  • Swagger UI：http://localhost:3000/api/ui
  • OpenAPI JSON：http://localhost:3000/api/doc
• 生产模式（pnpm start）：
  • 前端页面：http://localhost:8080
  • API：http://localhost:8080/api
  • Swagger UI：http://localhost:8080/api/ui
  • OpenAPI JSON：http://localhost:8080/api/doc