Skip to content

Commit 039ff96

Browse files
committed
update docs
1 parent 64d652a commit 039ff96

File tree

1 file changed

+44
-18
lines changed

1 file changed

+44
-18
lines changed

docs/backend/summary/quick-start.md

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -46,33 +46,59 @@ title: 快速开始
4646

4747
3. 安装依赖包
4848

49-
::: warning
50-
此项目使用 uv 作为项目管理器,您需要先 [安装 uv](https://docs.astral.sh/uv/getting-started/installation/)
51-
如果您本地已经存在 uv, 建议将其升级至最新版本
52-
:::
49+
1. 架构依赖
50+
51+
::: warning
52+
此项目使用 uv 作为项目管理器,您需要先 [安装 uv](https://docs.astral.sh/uv/getting-started/installation/)
53+
如果您本地已经存在 uv, 建议将其升级至最新版本
54+
:::
55+
56+
拉取项目到本地后,在项目根目录打开终端,执行以下命令安装架构依赖
57+
58+
::: code-tabs
59+
@tab <Icon name="material-icon-theme:uv" />uv - sync
60+
61+
```shell:no-line-numbers
62+
uv sync --frozen
63+
```
64+
65+
@tab <Icon name="material-icon-theme:uv" />uv - pip
66+
67+
```shell:no-line-numbers
68+
uv pip install -r requirements.txt
69+
```
70+
71+
:::
72+
73+
2. 插件依赖
5374
54-
- 架构依赖
75+
::: warning
76+
为了实现插件 0 耦合,插件依赖并未使用 uv 进行管理。执行以下脚本后,后期如果仍需同步环境依赖,请务必使用命令:
77+
`uv sync --frozen --inexact`
78+
:::
5579
56-
拉取项目到本地后,在项目根目录打开终端,执行以下命令安装架构依赖
80+
执行 `backend/scripts/init_plugin.py` 文件安装插件依赖
5781
58-
::: code-tabs
59-
@tab <Icon name="material-icon-theme:uv" />uv - sync
82+
::: details 报错:ModuleNotFoundError: No module named 'backend'
6083
61-
```shell:no-line-numbers
62-
uv sync --frozen
63-
```
84+
1. 自行搜索:将源根到添加到 PYTHONPATH
85+
2. 执行以下命令:
6486
65-
@tab <Icon name="material-icon-theme:uv" />uv - pip
87+
Linux/Mac:
6688
67-
```shell:no-line-numbers
68-
uv pip install -r requirements.txt
69-
```
89+
```sh
90+
# 修改 /path/to/fba 为您本地 fba 项目路径
91+
export PYTHONPATH=$PYTHONPATH:/path/to/fba
92+
```
7093
71-
:::
94+
Windows:
7295
73-
- 插件依赖
96+
```sh
97+
# 修改 D:\path\to\fba 为您本地 fba 项目路径
98+
set PYTHONPATH=%PYTHONPATH%;D:\path\to\fba
99+
```
74100
75-
执行 `backend/scripts/init_plugin.py` 文件安装插件依赖
101+
:::
76102
77103
4. 创建数据库:`fba`,选择 utf8mb4 编码;PostgreSQL 用户可忽略编码
78104
5. 启动 Redis

0 commit comments

Comments
 (0)