Skip to content

Commit 13eb108

Browse files
committed
update docs
1 parent a0cbba1 commit 13eb108

File tree

3 files changed

+41
-28
lines changed

3 files changed

+41
-28
lines changed

docs/changelog.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,34 @@ title: 更新日志
99
的成熟与稳定,更意味着它已完全通过验证,可以安心投入生产环境使用。在未来的版本迭代中,我们将持续为开发者带来更优质的产品体验。敬请期待!🤗
1010
:::
1111

12-
## [v1.0.3](https://github.com/fastapi-practices/fastapi_best_architecture/releases/tag/v1.0.3) - 2025-03-11
12+
<a id="v1.0.4"></a>
13+
14+
## [v1.0.4](https://github.com/fastapi-practices/fastapi_best_architecture/releases/tag/v1.0.4) - 2025-03-28
1315

1416
### What's Changed
1517

16-
* Update the changelog for v1.0.2 by [@wu-clan](https://github.com/wu-clan)
17-
in [#536](https://github.com/fastapi-practices/fastapi_best_architecture/pull/536)
18-
* Update docker scripts in backend README by [@wu-clan](https://github.com/wu-clan)
19-
in [#537](https://github.com/fastapi-practices/fastapi_best_architecture/pull/537)
20-
* Refactor toml and dependencies file dir by [@wu-clan](https://github.com/wu-clan)
21-
in [#538](https://github.com/fastapi-practices/fastapi_best_architecture/pull/538)
22-
* Fix typos in Dockerfile comments by [@huyuwei1996](https://github.com/huyuwei1996)
23-
in [#539](https://github.com/fastapi-practices/fastapi_best_architecture/pull/539)
24-
* Fix Dockerfile mounts for dependency installation by [@huyuwei1996](https://github.com/huyuwei1996)
25-
in [#540](https://github.com/fastapi-practices/fastapi_best_architecture/pull/540)
26-
* Add Aliyun mirror to PyPI index in pyproject.toml by [@huyuwei1996](https://github.com/huyuwei1996)
27-
in [#541](https://github.com/fastapi-practices/fastapi_best_architecture/pull/541)
28-
* Update docker scripts and nginx conf by [@wu-clan](https://github.com/wu-clan)
29-
in [#542](https://github.com/fastapi-practices/fastapi_best_architecture/pull/542)
18+
- Update the changelog for v1.0.3 by [@wu-clan](https://github.com/wu-clan) in [#543](https://github.com/fastapi-practices/fastapi_best_architecture/pull/543)
19+
- Updated the backend contribution guide by [@wu-clan](https://github.com/wu-clan) in [#544](https://github.com/fastapi-practices/fastapi_best_architecture/pull/544)
20+
- Optimize the return of relationship interfaces by [@wu-clan](https://github.com/wu-clan) in [#545](https://github.com/fastapi-practices/fastapi_best_architecture/pull/545)
21+
- Optimize the dynamic import of data models by [@wu-clan](https://github.com/wu-clan) in [#546](https://github.com/fastapi-practices/fastapi_best_architecture/pull/546)
22+
- Update git and docker ignore files by [@wu-clan](https://github.com/wu-clan) in [#547](https://github.com/fastapi-practices/fastapi_best_architecture/pull/547)
23+
- Optimize dependencies to reduce package size by [@wu-clan](https://github.com/wu-clan) in [#548](https://github.com/fastapi-practices/fastapi_best_architecture/pull/548)
24+
- Fix async install plugin dependencies for windows by [@wu-clan](https://github.com/wu-clan) in [#549](https://github.com/fastapi-practices/fastapi_best_architecture/pull/549)
25+
- Fix return schema of the config api by [@wu-clan](https://github.com/wu-clan) in [#551](https://github.com/fastapi-practices/fastapi_best_architecture/pull/551)
26+
- Optimize schemas with model relationships by [@wu-clan](https://github.com/wu-clan) in [#552](https://github.com/fastapi-practices/fastapi_best_architecture/pull/552)
27+
- Fix filters for opera log query list by [@ThankCat](https://github.com/ThankCat) in [#554](https://github.com/fastapi-practices/fastapi_best_architecture/pull/554)
28+
- Fix the celery env in docker compose by [@wu-clan](https://github.com/wu-clan) in [#555](https://github.com/fastapi-practices/fastapi_best_architecture/pull/555)
29+
- Update volumes of redis in docker compose by [@wu-clan](https://github.com/wu-clan) in [#556](https://github.com/fastapi-practices/fastapi_best_architecture/pull/556)
30+
- Fix the query for the sub department by [@PoetryL](https://github.com/PoetryL) in [#557](https://github.com/fastapi-practices/fastapi_best_architecture/pull/557)
31+
- Optimize codes and comments with cursor by [@wu-clan](https://github.com/wu-clan) in [#550](https://github.com/fastapi-practices/fastapi_best_architecture/pull/550)
32+
33+
### New Contributors
34+
35+
- [@ThankCat](https://github.com/ThankCat) made their first contribution in [#554](https://github.com/fastapi-practices/fastapi_best_architecture/pull/554)
36+
- [@PoetryL](https://github.com/PoetryL) made their first contribution in [#557](https://github.com/fastapi-practices/fastapi_best_architecture/pull/557)
37+
38+
## 完整日志
3039

3140
::: demo-wrapper title="Full Changelog"
32-
完整版日志请查看[CHANGELOG.md](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/CHANGELOG.md)
41+
完整日志请查看[CHANGELOG.md](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/CHANGELOG.md)
3342
:::

docs/guide/deploy/Docker.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ title: Docker 部署
1212

1313
### 后端
1414

15-
::: steps
15+
:::: steps
1616

1717
1. env
1818

19-
`backend` 目录中,创建环境变量文件
19+
`backend` 目录打开终端,创建环境变量文件
2020

2121
```shell:no-line-numbers
2222
touch .env
@@ -29,24 +29,27 @@ title: Docker 部署
2929
```
3030

3131
2. 按需修改配置文件 `backend/core/conf.py``.env`
32-
3. 务必在 `Dockerfile` 所在目录打开终端
33-
4. 运行以下命令构建容器
32+
3. 构建容器
33+
34+
在项目根目录中打开终端,执行以下命令
3435

36+
::: note
3537
如果容器要在本地启动,需要将 `.env` 中的 `127.0.0.1` 更改为 `host.docker.internal`
38+
:::
3639

3740
```shell:no-line-numbers
3841
docker build -f Dockerfile -t fba_backend_independent .
3942
```
4043

41-
5. 启动容器
44+
4. 启动容器
4245

4346
由于构建不包含数据库,请确保本地已安装并启动相关数据库(mysql / postgresql、redis)
4447

4548
```shell:no-line-numbers
4649
docker run -d -p 8000:8000 --name fba_server fba_backend_independent
4750
```
4851

49-
:::
52+
::::
5053

5154
## 服务器部署
5255

@@ -70,7 +73,7 @@ title: Docker 部署
7073

7174
2. env
7275

73-
`backend` 目录中,创建环境变量文件
76+
`backend` 目录打开终端,创建环境变量文件
7477

7578
```shell:no-line-numbers
7679
touch .env
@@ -103,8 +106,9 @@ title: Docker 部署
103106

104107
@[code yml :collapsed-lines=6](../../code/docker-compose.yml)
105108

106-
5. 务必在 `docker-compose.yml` 所在目录打开终端
107-
6. 执行一键启动命令
109+
5. 执行一键启动命令
110+
111+
在项目根目录中打开终端,执行以下命令
108112

109113
::: warning
110114
命令执行期间遇到镜像拉取问题请自行 Google
@@ -114,7 +118,7 @@ title: Docker 部署
114118
docker-compose up -d --build
115119
```
116120

117-
7. 等待命令执行完成
121+
6. 等待命令执行完成
118122
::::
119123

120124
### 前端

docs/guide/summary/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ title: 快速开始
5050

5151
- 架构依赖
5252

53-
拉取项目到本地后,在项目根目录,执行以下命令安装架构依赖
53+
拉取项目到本地后,在项目根目录打开终端,执行以下命令安装架构依赖
5454

5555
::: code-tabs
5656
@tab <Icon name="material-icon-theme:uv" />uv - pip
@@ -281,7 +281,7 @@ title: 快速开始
281281
1. 创建测试数据库 `fba_test`,选择 utf8mb4 编码,postgres 用户可忽略编码
282282
2. 创建数据库表,执行 `backend/sql/` 目录下对应数据库的 `create_tables.sql` 脚本
283283
3. 初始化测试数据,执行 `backend/sql/` 目录下对应数据库的 `init_test_data.sql` 脚本
284-
4. 在项目根目录,执行单元测试命令
284+
4. 在项目根目录打开终端,执行以下单元测试命令
285285

286286
```shell:no-line-numbers
287287
pytest -vs --disable-warnings

0 commit comments

Comments
 (0)