Files
foka-ci/docs/development/setup.md
hurole d22fdc9618 feat: 实现环境变量预设功能 & 移除稀疏检出
## 后端改动
- 添加 Project.envPresets 字段(JSON 格式)
- 移除 Deployment.env 字段,统一使用 envVars
- 更新部署 DTO,支持 envVars (Record<string, string>)
- pipeline-runner 支持解析并注入 envVars 到环境
- 移除稀疏检出模板和相关环境变量
- 优化代码格式(Biome lint & format)

## 前端改动
- 新增 EnvPresetsEditor 组件(支持单选/多选/输入框类型)
- 项目创建/编辑界面集成环境预设编辑器
- 部署界面基于预设动态生成环境变量表单
- 移除稀疏检出表单项
- 项目详情页添加环境变量预设配置 tab
- 优化部署界面布局(基本参数 & 环境变量分区)

## 文档
- 添加完整文档目录结构(docs/)
- 创建设计文档 design-0005(部署流程重构)
- 添加 API 文档、架构设计文档等

## 数据库
- 执行 prisma db push 同步 schema 变更
2026-01-03 22:59:20 +08:00

1.6 KiB
Raw Blame History

title, summary, owners, status
title summary owners status
开发与本地环境搭建 针对本项目的本地开发、数据库与调试指南。
team
backend
stable

开发与本地环境搭建

1. 安装依赖

建议使用 pnpm 管理工作区依赖:

# 在仓库根
pnpm install

或者只在 server 子包安装:

cd apps/server
pnpm install

2. 生成 Prisma Client

cd apps/server
npx prisma generate

如果需要执行迁移(开发场景):

npx prisma migrate dev --name init

数据库:项目使用 SQLiteapps/server/prisma/schema.prisma),迁移会在本地创建 .db 文件。

3. 启动服务

并行启动 workspace 中所有 dev 脚本(推荐):

pnpm dev

或单独启动 server

cd apps/server
pnpm dev

服务默认端口:3001。如需修改:

PORT=4000 pnpm dev

4. 常见开发命令

  • 运行测试脚本(仓库自带):
cd apps/server
node test.js
  • TypeScript 类型检查(本地可使用 tsc
npx tsc --noEmit

5. 环境变量与第三方集成

常见 envGITEA_URL, GITEA_CLIENT_ID, GITEA_REDIRECT_URI, PORT, NODE_ENV

登录采用 Gitea OAuth未配置时某些 auth 接口会返回 401需要先登录获取 session。

6. 运行与调试要点

  • 代码通过装饰器注册路由(见 apps/server/decorators/route.tsapps/server/libs/route-scanner.ts)。
  • Prisma client 生成路径:apps/server/generated
  • 若变更 Prisma schema请执行 prisma generate 并更新迁移。