Skip to content

Commit af7ae01

Browse files
committed
update docs
1 parent 30c00fc commit af7ae01

File tree

4 files changed

+65
-51
lines changed

4 files changed

+65
-51
lines changed

docs/.vuepress/navbar.ts

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,21 @@ import {defineNavbarConfig} from "vuepress-theme-plume";
22

33
export const myNavbar = defineNavbarConfig([
44
{
5-
text: '演示',
5+
text: 'UI 演示',
66
items: [
77
{
8-
text: 'Arco Design 实验版本',
8+
text: 'Arco Design Vue 实验性实施',
99
link: 'https://fba.xwboy.top/'
10+
//link: 'https://github.com/fastapi-practices/fastapi_best_architecture_ui'
11+
},
12+
{
13+
text: 'Ant Desgin Vue 孵化中...',
14+
link: 'https://github.com/fastapi-practices/fba_ui'
1015
}
1116
]
1217
},
1318
{
14-
text: 'Beta',
19+
text: '0.0.0 Beta',
1520
items: [
1621
{
1722
text: '参与贡献',

docs/guide/deploy/Docker.md

Lines changed: 31 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,32 @@ title: Docker 部署
88
如果 docker 容器启动时端口被占用,会导致启动失败,建议在启动前检查本地端口占用情况
99
:::
1010

11-
## 本机部署
11+
## 本地部署
1212

13-
本机部署是为了能够快捷的提供本地 API 服务
13+
本地部署是为了能够快捷的提供本地 API 服务
1414

1515
### 后端
1616

17-
:::: steps
18-
19-
1. env
20-
21-
进入 `deploy/backend/docker-compose` 目录,创建环境变量文件 `.env`
22-
23-
```shell
24-
touch .env.server ../../../backend/.env
25-
```
26-
27-
将初始化环境变量配置拷贝到环境变量文件中
17+
::: steps
2818

29-
```shell
30-
cp .env.server ../../../backend/.env
31-
```
19+
1. 确保你位于项目根目录
20+
2. 运行以下命令构建容器
3221

33-
2. 按需修改配置文件 `backend/core/conf.py``.env`
34-
3. 执行一键启动命令
22+
```shell
23+
docker build -f backend/backend.dockerfile -t fba_backend_independent .
24+
```
3525

36-
::: info
37-
命令执行期间遇到镜像拉取问题请自行 Google
38-
:::
26+
3. 启动容器
3927

40-
```shell
41-
docker-compose up -d --build
42-
```
28+
```shell
29+
docker run -d fba_backend_independent -p 8000:8000 --name fba_app
30+
```
4331

44-
4. 等待命令执行完成
45-
5. 打开浏览器访问:[http://127.0.0.1:8000/api/v1/docs](http://127.0.0.1:8000/api/v1/docs)
46-
::::
32+
:::
4733

4834
### 前端
4935

50-
此教程不提供前端本机部署方案,对于前后端本地开发或联调,请转至文档[本地开发](../summary/quick-start.md#本地开发)
36+
无前端本地部署方案,请转至文档 [本地开发](../summary/quick-start.md#本地开发)
5137

5238
## 服务器部署
5339

@@ -61,8 +47,9 @@ title: Docker 部署
6147
1. 拉取代码到服务器
6248

6349
将代码拉取到服务器通常采用 ssh 方式(更安全),但是你也可以选择使用 https 方式,具体方式请根据个人自行决定,如果使用 ssh
64-
方式拉取代码,
65-
请自行 Google 拉取教程,如果使用 https 方式,你可以查看 [后端步骤 2](../summary/quick-start.md#后端)
50+
方式拉取代码,请自行 Google 拉取教程
51+
52+
如果使用 https 方式,你可以查看 [后端步骤 2](../summary/quick-start.md#后端)
6653

6754
2. env
6855

@@ -75,7 +62,7 @@ title: Docker 部署
7562
将初始化环境变量配置拷贝到环境变量文件中
7663

7764
::: warning
78-
环境变量默认使用 MySQL 数据库,如果你需要使用 PostgreSQL,需修改 `.env.server` 部分配置如下:
65+
如果你需要使用 PostgreSQL 数据库,需修改 `.env.server` 部分配置如下:
7966
```env
8067
DATABASE_TYPE='postgresql'
8168
DATABASE_HOST='fba_postgres'
@@ -95,8 +82,6 @@ title: Docker 部署
9582

9683
4. 更新脚本文件
9784

98-
如果你没有前端需求,请查看 [本机部署](#本机部署),否则,请查看下方脚本并修改 `docker-compose.yml` 文件
99-
10085
```yaml :collapsed-lines=2
10186
networks:
10287
fba_network:
@@ -300,16 +285,23 @@ title: Docker 部署
300285

301286
### 前端
302287

303-
::: caution
304-
我们提供此前端部署教程的目的是为你提供前端 Docker 部署解决方案,请记住我们的声明,此前端项目仅作为效果演示,而不是用于生产!
305-
:::
306-
307-
:::: steps
288+
::::: steps
308289

309290
1. 拉取代码到服务器
310291
2. env
311292

293+
:::: details Arco Desgin Vue
294+
295+
::: caution
296+
这是一个实验版本,它仅用作效果演示,而不是用于生产!
297+
:::
298+
312299
修改 `.env.production` 中的 `VITE_API_BASE_URL` 为域名地址
300+
::::
301+
302+
:::: details Ant Desgin Vue
303+
生产可用?我知道你很急,但你先别急...
304+
::::
313305

314306
3. 更新 nginx 配置
315307

@@ -465,7 +457,7 @@ title: Docker 部署
465457
docker-compose run fba_ui
466458
```
467459

468-
::::
460+
:::::
469461

470462
## 注意事项
471463

docs/guide/summary/quick-start.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -147,10 +147,10 @@ title: 快速开始
147147

148148
### 前端
149149

150-
::: caution
151-
目前它仅作为效果演示,而不是用于生产!
150+
::::: details Arco Desgin Vue
152151

153-
如果你不想因前端依赖安装问题带来困扰,请务必使用 yarn v1.x 版本
152+
::: caution
153+
这是一个实验版本,它仅用作效果演示,而不是用于生产!
154154
:::
155155

156156
:::: steps
@@ -162,6 +162,11 @@ title: 快速开始
162162

163163
2. 安装和启动
164164

165+
::: warning
166+
第一次启动可能会很慢,你可以查看此 [Issue](https://github.com/fastapi-practices/fastapi_best_architecture_ui/issues/72)
167+
查看详情
168+
:::
169+
165170
安装依赖
166171

167172
```shell
@@ -174,12 +179,14 @@ title: 快速开始
174179
yarn dev
175180
```
176181

177-
::: tip
178-
第一次启动可能会很慢,你可以查看此 [Issue](https://github.com/fastapi-practices/fastapi_best_architecture_ui/issues/72)
179-
查看详情
180-
:::
181-
182182
::::
183+
:::::
184+
185+
::::: details Ant Desgin Vue
186+
187+
生产可用?我知道你很急,但你先别急...
188+
189+
:::::
183190

184191
## 开发流程
185192

docs/plugins.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,14 @@
22
title: 插件市场
33
---
44

5-
我们正在积极调研此功能,它将提供类似于 gin-vue-admin 中插件功能
5+
调研中...
6+
7+
<p style="color:rgb(255, 75, 75)">你不应对此功能充满期待 😅</p>
8+
9+
## 愿景
10+
11+
提供一个共创平台,告别高耦合集成,让功能变得可轻松 Hot Swap
12+
13+
## 收费吗
14+
15+
是否收费将取决于插件开发者

0 commit comments

Comments
 (0)