Skip to content

Commit 125c9f0

Browse files
committed
update docs
1 parent e7108b1 commit 125c9f0

File tree

1 file changed

+14
-21
lines changed

1 file changed

+14
-21
lines changed

docs/backend/summary/quick-start.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,12 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
1818
[PostgreSQL 用户,请先移步到 **切换数据库**](../reference/db.md){.read-more}
1919
- <p>Redis 推荐最新稳定版</p>
2020

21-
2. 准备 Git 仓库 <Badge type="warning" text="二选一" />
21+
2. 创建数据库:`fba`
22+
23+
MySQL 用户请选择 utf8mb4 编码,PostgreSQL 用户直接创建即可
24+
25+
3. 启动 Redis
26+
4. 准备源码 <Badge type="warning" text="二选一" />
2227

2328
::: tabs
2429
@tab 拉取源代码
@@ -36,47 +41,35 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
3641
![use_this_template](/images/use_this_template.png)
3742
:::
3843

39-
3. 安装依赖
44+
5. 安装依赖
4045

41-
::: warning
42-
此项目使用 uv 作为项目管理器,您需要先 [安装 uv](https://docs.astral.sh/uv/getting-started/installation/)
43-
如果您本地已经存在 uv, 建议将其升级至最新版本
44-
:::
46+
此项目使用 uv 作为项目管理器,建议您 [安装 uv](https://docs.astral.sh/uv/getting-started/installation/)
4547

46-
拉取项目到本地后,在项目根目录打开终端,执行以下命令安装架构依赖
48+
如果您本地已经存在 uv,建议通过 `uv self update` 升级至最新版本
4749

4850
::: code-tabs
4951
@tab <Icon name="material-icon-theme:uv" />uv - sync
5052

5153
```shell:no-line-numbers
52-
uv sync --frozen
54+
uv sync
5355
```
5456

5557
@tab <Icon name="material-icon-theme:uv" />uv - pip
5658

5759
```shell:no-line-numbers
5860
uv pip install -r requirements.txt
5961
```
60-
6162
:::
6263

63-
4. 创建数据库:`fba`,选择 utf8mb4 编码(PostgreSQL 用户可忽略编码)
64-
5. 启动 Redis
6564
6. env
6665

6766
`backend` 目录打开终端,执行以下命令创建环境变量文件
6867

69-
```shell:no-line-numbers
70-
touch .env
71-
```
72-
73-
将初始化环境变量配置拷贝到环境变量文件中
74-
7568
```shell:no-line-numbers
7669
cp .env.example .env
7770
```
7871

79-
7. 按需修改配置文件 `backend/core/conf.py``.env`
72+
7. 按需修改配置文件`backend/core/conf.py``.env`
8073
8. 创建数据库表 <Badge type="warning" text="二选一" />
8174

8275
::: tabs
@@ -101,7 +94,7 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
10194

10295
9. 启动 celery worker, beat 和 flower <Badge type="warning" text="此步骤为可选,可直接跳过" />
10396

104-
`根目录` `backend 目录` 打开终端,执行以下命令启动 celery 相关服务
97+
`根目录` 打开终端,执行以下命令启动 celery 相关服务
10598

10699
::: code-tabs
107100
@tab Worker
@@ -130,7 +123,7 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
130123
131124
10. 启动
132125
133-
在 `根目录` 或 `backend 目录` 打开终端,执行以下命令启动 FastAPI 服务
126+
在 `根目录` 打开终端,执行以下命令启动 FastAPI 服务
134127
135128
```shell:no-line-numbers
136129
fba run
@@ -143,7 +136,7 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
143136
插件:执行 `插件/sql/` 目录下对应主键模式的脚本
144137
145138
::: info
146-
你可以选择通过 [CLI](../reference/cli.md) 快速执行这些脚本
139+
你也可以选择通过 [CLI](../reference/cli.md) 快速执行这些脚本
147140
:::
148141
149142
12. 打开浏览器访问:[http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)

0 commit comments

Comments
 (0)