Skip to content

Commit cebafe6

Browse files
committed
update docs
1 parent eac8a0c commit cebafe6

File tree

2 files changed

+29
-26
lines changed

2 files changed

+29
-26
lines changed
1.56 KB
Loading

docs/backend/summary/quick-start.md

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

45-
5. 安装依赖
45+
5. env
46+
47+
`backend` 目录打开终端,执行以下命令创建环境变量文件
48+
49+
```shell:no-line-numbers
50+
cp .env.example .env
51+
```
52+
53+
6. 按需修改配置文件:`backend/core/conf.py``.env`
54+
7. 安装依赖
4655

4756
此项目使用 uv 作为项目管理器,建议您 [安装 uv](https://docs.astral.sh/uv/getting-started/installation/)
4857

@@ -61,24 +70,18 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
6170
uv pip install -r requirements.txt
6271
```
6372
:::
73+
8. 创建数据库表和测试数据 <Badge type="warning" text="二选一" />
6474

65-
6. env
66-
67-
`backend` 目录打开终端,执行以下命令创建环境变量文件
75+
::: tabs
76+
@tab CLI
77+
`根目录` 打开终端,执行以下命令
6878

6979
```shell:no-line-numbers
70-
cp .env.example .env
80+
fba init
7181
```
7282

73-
7. 按需修改配置文件:`backend/core/conf.py``.env`
74-
8. 创建数据库表 <Badge type="warning" text="二选一" />
75-
76-
::: tabs
77-
@tab 自动创建
78-
跳过此步骤,启动 fba 后将自动创建
79-
80-
@tab Alembic 迁移
81-
`backend` 目录 打开终端
83+
@tab Alembic + 手动
84+
`根目录` 打开终端,执行以下命令
8285

8386
生成迁移文件
8487

@@ -91,11 +94,21 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
9194
```shell:no-line-numbers
9295
alembic upgrade head
9396
```
97+
98+
初始化测试数据
99+
100+
架构:执行 `backend/sql/` 目录下对应主键模式的脚本
101+
102+
插件:执行 `backend/plugin/sql/` 目录下对应主键模式的脚本
103+
104+
```shell:no-line-numbers
105+
fba --sql xxx.sql
106+
```
94107
:::
95108

96109
9. 启动
97110

98-
`根目录` 打开终端,执行以下命令启动 FastAPI 服务
111+
`根目录` 打开终端,执行以下命令
99112

100113
```shell:no-line-numbers
101114
fba run
@@ -130,17 +143,7 @@ fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户
130143
beat 服务,相关接口将自动恢复正常
131144
:::
132145
133-
11. 初始化测试数据
134-
135-
架构:执行 `backend/sql/` 目录下对应主键模式的脚本
136-
137-
插件:执行 `插件/sql/` 目录下对应主键模式的脚本
138-
139-
::: info
140-
你也可以选择通过 [CLI](../reference/cli.md) 快速执行这些脚本
141-
:::
142-
143-
12. 打开浏览器访问:[http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
146+
11. 打开浏览器访问:[http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
144147
145148
::::
146149

0 commit comments

Comments
 (0)