docs: 添加本地开发相关教程

This commit is contained in:
WJG 2024-06-10 17:55:00 +08:00
parent 6999b2c35d
commit 2dc7ba30dd
No known key found for this signature in database
GPG Key ID: 258474EF8590014A
4 changed files with 63 additions and 16 deletions

View File

@ -1,3 +1,63 @@
# 🛠️ 本地开发
整理中,稍后更新。
如果你想要修改代码,本地调试开发 `MiGPT` 可以参考以下教程。
## 初始化
```shell
# 克隆项目到本地
git clone https://github.com/idootop/mi-gpt.git
cd mi-gpt
# 安装依赖
pnpm install
# 构建项目
pnpm build
```
然后按照 [⚙️ 参数设置](https://github.com/idootop/mi-gpt/blob/main/docs/settings.md) 教程,配置好你的 `.env``.migpt.js` 文件。
## 运行
有两种运行方式VS Code Debug 或 NPM Script
- **NPM Script**: 配置好 `.env``.migpt.js` 后直接使用 `pnpm run dev` 启动 `MiGPT`
- **VScode Debug**:使用 VS Code 打开项目根目录,然后按 `F5` 开始调试 `MiGPT`。注意,启动前请在 `tests/migpt.ts` 文件中配置 `MiGPT` 相关参数。
> 本项目默认在 Node 20 中运行,如果你的 Node 版本过低可能无法正常启动本项目。
## 构建 Docker 镜像
此项目默认支持 `linux/amd64`, `linux/arm64``linux/arm32/v7`,可使用以下命令构建指定平台的镜像:
```shell
docker build --platform linux/arm/v7 -t mi-gpt .
```
运行构建后的 docker
```shell
docker run --env-file $(pwd)/.env -v $(pwd)/.migpt.js:/app/.migpt.js mi-gpt
```
## 常见问题
### 提示找不到 bot项目启动失败
这是由于重建了本地数据库,导致本地映射记录不匹配。运行以下命令修复:
```shell
pnpm run db:reset
```
或者手动删除以下文件,重新运行即可恢复:
- .mi.json
- .bot.json
- prisma/app.db
- prisma/app.db-journal
### 提示初始化 Mi Service 失败
请检查你的小米 ID 和密码配置是否正确和生效,可在 VS Code 中下断点调试。

View File

@ -106,20 +106,6 @@ docker run -d --env-file %cd%\.env ^
</details>
### Q我 Clone 了这个仓库,但是本地启动失败
如果你是通过 clone 本项目仓库的方式来运行,记得在 `start` 之前先 `build` 一下。
```shell
pnpm install && pnpm build && pnpm start
```
另外, `start` 命令默认没有注入 `.env` 文件里的环境变量。你可以在 VS Code 里按 F5 直接运行,会自动读取 `.env` ,或者将启动脚本改为:
```shell
node --env-file=.env app.js
```
### Q怎样使用豆包的音色
此功能需要豆包 TTS 接口支持,本项目暂不对外提供此服务。

View File

@ -21,7 +21,7 @@
- 优化找不到小爱设备的提示文案以及 FAQ 教程。https://github.com/idootop/mi-gpt/issues/28#issuecomment-2153645819
- 添加关于唤醒小爱、唤醒词、唤醒模式的说明和注意事项。
- ✅ 添加关于 clone 项目本地运行的相关配置教程。
- 添加关于本地构建本项目 docker 镜像的说明。
- 添加关于本地构建本项目 docker 镜像的说明。
- 添加关于 playingCommand 的详细说明,默认不需要配置。
- 添加常见小爱音箱型号的支持情况和参数列表。
- 添加关于 clone 项目本地运行提示找不到 bot 的相关说明。

View File

@ -21,6 +21,7 @@
],
"scripts": {
"start": "node ./app.js",
"dev": "node --env-file=.env ./app.js",
"build": "npx -y prisma generate && tsup",
"db:gen": "npx -y prisma migrate dev --name init",
"db:reset": "rm -f .mi.json .bot.json prisma/app.db prisma/app.db-journal",