## 后端改动 - 添加 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 变更
1.8 KiB
1.8 KiB
title, summary, tags, owners, status, version
| title | summary | tags | owners | status | version | ||||
|---|---|---|---|---|---|---|---|---|---|
| 快速开始 | 本文档介绍如何在本地启动与运行项目的基础步骤。 |
|
|
stable | 1.0.0 |
快速开始
前置条件
- Node.js >= 18
- pnpm
- 克隆权限(或访问仓库)
克隆与依赖安装
git clone <repo-url>
cd foka-ci
pnpm install
说明:仓库使用 pnpm workspace,根目录脚本 pnpm dev 会并行启动工作区内的 dev 脚本。
运行服务(开发)
- 从仓库根(并行运行所有 dev 脚本):
pnpm dev
- 单独运行 server:
cd apps/server
pnpm install
pnpm dev # 等同于: tsx watch ./app.ts
服务器默认监听端口 3001(可通过 PORT 环境变量覆盖)。API 前缀为 /api。
Prisma 与数据库
项目使用 SQLite(见 apps/server/prisma/schema.prisma)。如果需要生成 Prisma Client 或运行迁移:
cd apps/server
npx prisma generate
npx prisma migrate dev --name init # 本地开发使用
生成的 Prisma Client 位于 apps/server/generated(由 schema 中的 generator 指定)。
环境变量(常用)
GITEA_URL、GITEA_CLIENT_ID、GITEA_REDIRECT_URI:用于 OAuth 登录(Gitea)。PORT:服务监听端口,默认3001。NODE_ENV:环境(development/production)。
将敏感值放入 .env(不要将 .env 提交到仓库)。
运行脚本与测试
cd apps/server
node test.js # 运行仓库自带的简单测试脚本
其他说明
- 文档目录位于
docs/,设计模板在docs/.meta/templates/。 - API 路由由装饰器注册,路由前缀为
/api,在apps/server/middlewares/router.ts中可查看。
更多开发细节请参见 docs/development/setup.md 与 docs/api/endpoints.md。