Skip to content

Commit fb59d14

Browse files
committed
update docs
1 parent 24c6cdc commit fb59d14

File tree

2 files changed

+47
-54
lines changed

2 files changed

+47
-54
lines changed

docs/backend/summary/quick-start.md

Lines changed: 45 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -41,61 +41,29 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
4141
![use_this_template](/images/use_this_template.png)
4242
:::
4343

44-
3. 安装依赖包
44+
3. 安装依赖
4545

46-
1. 架构依赖
47-
48-
::: warning
49-
此项目使用 uv 作为项目管理器,您需要先 [安装 uv](https://docs.astral.sh/uv/getting-started/installation/)
50-
如果您本地已经存在 uv, 建议将其升级至最新版本
51-
:::
52-
53-
拉取项目到本地后,在项目根目录打开终端,执行以下命令安装架构依赖
54-
55-
::: code-tabs
56-
@tab <Icon name="material-icon-theme:uv" />uv - sync
57-
58-
```shell:no-line-numbers
59-
uv sync --frozen
60-
```
61-
62-
@tab <Icon name="material-icon-theme:uv" />uv - pip
63-
64-
```shell:no-line-numbers
65-
uv pip install -r requirements.txt
66-
```
67-
68-
:::
69-
70-
2. 插件依赖
71-
72-
执行 `backend/scripts/init_plugin.py` 文件安装插件依赖
73-
74-
::: details 报错:ModuleNotFoundError: No module named 'backend'
75-
76-
1. 自行搜索:将源根到添加到 PYTHONPATH
77-
2. 执行以下命令:
46+
::: warning
47+
此项目使用 uv 作为项目管理器,您需要先 [安装 uv](https://docs.astral.sh/uv/getting-started/installation/)
48+
如果您本地已经存在 uv, 建议将其升级至最新版本
49+
:::
7850

79-
Linux/Mac:
51+
拉取项目到本地后,在项目根目录打开终端,执行以下命令安装架构依赖
8052

81-
```sh
82-
# 修改 /path/to/fba 为您本地 fba 项目路径
83-
export PYTHONPATH=$PYTHONPATH:/path/to/fba
84-
```
53+
::: code-tabs
54+
@tab <Icon name="material-icon-theme:uv" />uv - sync
8555

86-
Windows:
56+
```shell:no-line-numbers
57+
uv sync --frozen
58+
```
8759

88-
```sh
89-
# 修改 D:\path\to\fba 为您本地 fba 项目路径
90-
set PYTHONPATH=%PYTHONPATH%;D:\path\to\fba
91-
```
60+
@tab <Icon name="material-icon-theme:uv" />uv - pip
9261

93-
:::
62+
```shell:no-line-numbers
63+
uv pip install -r requirements.txt
64+
```
9465

95-
::: caution
96-
为了实现插件 0 耦合,插件依赖未使用 uv 进行管理。执行上面脚本文件后,如果后期您仍需同步环境依赖,请务必使用命令:
97-
`uv sync --frozen --inexact`,否则插件依赖将被 uv 自动清理!
98-
:::
66+
:::
9967

10068
4. 创建数据库:`fba`,选择 utf8mb4 编码(PostgreSQL 用户可忽略编码)
10169
5. 启动 Redis
@@ -163,12 +131,38 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
163131
在 `backend` 目录打开终端,执行以下命令启动 FastAPI 服务
164132
165133
```shell:no-line-numbers
166-
fastapi dev main.py
134+
fba run
167135
```
168136
169-
::: note
170-
此项目默认使用 CLI 启动服务,为了方便本地调试,你仍然可以选择在 IDE 中右键运行 `run.py` 文件
137+
:::: details 附加说明
138+
此项目默认使用 CLI 启动服务,为了方便 Debug,你可以在 IDE 中直接右键运行 `run.py` 文件
139+
140+
需要注意的是,为了实现插件 0 耦合,插件依赖未使用 uv 进行管理。Debug 前请务必使用 `fba run` 命令启动一次服务,
141+
以便自动安装插件依赖
142+
143+
您也可以执行 `backend/scripts/init_plugin.py` 文件手动安装插件依赖
144+
145+
::: warning ModuleNotFoundError: No module named 'backend'
146+
147+
1. 自行搜索:将源根到添加到 PYTHONPATH
148+
2. 执行以下命令:
149+
150+
Linux/Mac:
151+
152+
```sh
153+
# 修改 /path/to/fba 为本地 fba 项目根路径
154+
export PYTHONPATH=$PYTHONPATH:/path/to/fba
155+
```
156+
157+
Windows(cmd):
158+
159+
```sh
160+
# 修改 D:\path\to\fba 为本地 fba 项目根路径
161+
set PYTHONPATH=%PYTHONPATH%;D:\path\to\fba
162+
```
163+
171164
:::
165+
::::
172166
173167
11. 初始化测试数据
174168

docs/plugin/install.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,8 @@ title: 插件安装
1313

1414
1. 获取插件仓库源码并下载
1515
2. 将下载的源码文件夹直接拷贝到 `backend/plugin` 目录下
16-
3. 如果插件包含依赖(requirements.txt),执行 `backend/scripts/init_plugin.py` 文件安装依赖
17-
4. 根据插件说明(README.md)进行相关配置
18-
5. 重启服务
16+
3. 根据插件说明(README.md)进行相关配置
17+
4. 通过 CLI 重启服务
1918

2019
@tab ZIP
2120

0 commit comments

Comments
 (0)