Skip to content

Commit cc93048

Browse files
committed
update docs
1 parent 9711e08 commit cc93048

File tree

3 files changed

+20
-4
lines changed

3 files changed

+20
-4
lines changed

docs/guide/deploy/Docker.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ createTime: 2024/09/12 20:40:22
1111
1212
## 本机部署
1313

14+
> [!CAUTION]
15+
> **部署** 意味着你的所有代码已经准备就绪,可以用于生产,而本机部署则是为了能够快捷的提供本地 API 服务,所以,此教程仅提供 API 本机部署教程
16+
17+
### 后端
18+
1419
:::: steps
1520
1. env
1621

@@ -41,10 +46,15 @@ createTime: 2024/09/12 20:40:22
4146
5. 打开浏览器访问:[http://127.0.0.1:8000/api/v1/docs](http://127.0.0.1:8000/api/v1/docs)
4247
::::
4348

49+
### 前端
50+
51+
> [!CAUTION]
52+
> 此教程不提供前端本机部署方案,对于前后端本地开发或联调,你不应该进行部署,请转至文档:[本地开发](../summary/quick-start.md#本地开发)
53+
4454
## 服务器部署
4555

4656
> [!TIP]
47-
> 此教程以 https 为例
57+
> 此教程以 ==https== 为例,如果你没有相关经验,请自行 Google 进行了解
4858

4959
### 后端
5060

@@ -446,7 +456,7 @@ docker container prune
446456
docker system prune
447457
```
448458

449-
如果要同时清理所有悬空的镜像和未使用的卷
459+
清理所有悬空的镜像和卷
450460

451461
```shell
452462
docker system prune -a --volumes

docs/guide/deploy/legacy.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,10 @@ createTime: 2024/09/12 20:40:22
44
---
55

66
> [!IMPORTANT]
7-
> 目前暂不提供此部署方案
7+
> 由于传统部署方案涉及修改的地方较多且较为复杂,目前暂不提供此部署方案,如果你不是一个服务部署专家,这可能存在很多坑
8+
9+
> [!TIP]
10+
> 由于 FastAPI Best Architecture 线上服务器资源有限,当前使用【传统 + Docker】的方案进行部署,尽可能避免内存溢出导致的服务中断,
11+
> 我们后期会提供 BiliBili 免费教程(敬请期待)
12+
>
13+
> 但是抱歉,我们不提供一对一免费协助,它将是一个==付费咨询==

docs/guide/summary/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ createTime: 2024/09/12 20:40:22
139139
::: caution
140140
目前它仅作为效果演示,而不是用于生产!
141141

142-
如果你不想前端问题带来干扰,请务必使用 `yarn`
142+
如果你不想前端依赖安装问题带来困扰,请务必使用 `yarn` v1.x 版本
143143
:::
144144

145145
你可以跳转 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 查看详情

0 commit comments

Comments
 (0)