文件預覽
範本在 UUIDE 中開啟後的實際效果(與匯出 PDF 同貌)。
开发环境搭建指南
项目: · 适用系统:macOS / Windows / Linux · 文档版本:v · 维护人: · 2026- 月- 日
本指南面向新入职成员,按顺序执行约 分钟可完成搭建并跑通本地服务。遇到问题先查「常见问题」,仍未解决请在 群求助。
一、前置依赖
| 依赖 | 版本要求 | 安装方式 | 验证命令 |
|---|---|---|---|
| Git | ≥ 2.30 | 系统包管理器 | git --version |
| Node.js | LTS(用 nvm 安装) | nvm install |
node -v |
| 包理器 pnpm | ≥ | npm i -g pnpm |
pnpm -v |
| 运行时 | |||
| MySQL 8 | 8.0.x | Docker 镜像(推荐) | mysql --version |
二、获取代码与安装依赖
# 1) 克隆仓库(内网走 SSH,需先配置公钥)
git clone git@ : / .git && cd
# 2) 安装依赖(锁定版本,勿用 npm/yarn 混装)
pnpm install
# 3) 初始化子模块 / 生成代码
git submodule update --init
make generate
三、本地配置
复制环境模板并按需填写(真实密钥严禁提交,配置文件已被 .gitignore 忽略):
cp .env.example .env.local
| 配置项 | 说明 | 本地默认值 |
|---|---|---|
| DATABASE_URL | 本地数据库连接串 | root@tcp(127.0.0.1:3306)/ |
| REDIS_ADDR | 本地 Redis 地址 | 127.0.0.1:6379 |
| LLM_API_KEY | 内网中转平台申请 | — |
| AUTH_CLIENT_ID | 联调统一认证应用 ID |
四、初始化数据与启动
- 导入基础数据:
make db-migrate && make db-seed; - 启动依赖服务:
docker compose up -d(MySQL / Redis); - 启动应用:
make dev,首次启动自动执行迁移; - 验证:浏览器打开
http://localhost:,用测试账号 登录。
- 首页可正常访问,登录成功
- 核心链路 冒烟通过
- 运行
make test本地全绿
五、常见问题
Q1:依赖安装失败 / 下载超时?
切换内网镜像源:pnpm config set registry https:// ;仍失败删除 node_modules 与锁文件缓存后重试。
Q2:端口被占用?
lsof -i : 查找进程;本地端口可在 .env.local 中通过 修改。
Q3:数据库连接失败?
确认容器已启动且账号密码与 .env.local 一致;首次导入需先执行建库语句 CREATE DATABASE ;。
搭建完成后请阅读 README 与《编码规范》《分支管理规范》,并向 Mentor 确认仓库权限与任务认领流程。
怎麼使用
- 1下載安裝 UUIDE 桌面應用程式(官網首頁免費取得)
- 2開啟 UUIDE,進入首頁「範本庫」分頁,找到本範本
- 3點擊「使用」並選擇目標專案——範本會複製為專案裡的一般文件
- 4隨意編輯文字、表格與圖片,完成後可匯出 PDF
常見問題
- 這個範本是免費的嗎?
- 免費,可商業使用。UUIDE 官方範本全部免費提供,個人或商業情境皆可放心使用。
- 範本內容可以修改嗎?
- 可以。「使用」會把範本複製成你專案裡的一般文件,文字、表格、圖片都能直接編輯。
- 能匯出成 PDF 或 Word 嗎?
- UUIDE 內可一鍵匯出 PDF(與預覽同貌);Word 等格式可用複製貼上或後續匯入匯出功能轉換。