Skip to content

Commit 00a53ce

Browse files
authored
feat:update docs (#71)
1 parent a048403 commit 00a53ce

File tree

5 files changed

+42
-131
lines changed

5 files changed

+42
-131
lines changed

docs/README/build.md

Lines changed: 0 additions & 117 deletions
This file was deleted.

docs/README/deploy/docker-deploy.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Docker 部署
22

3-
[Databasir](https://github.com/vran-dev/databasir) 已经准备好了开箱即用的 Docker Image,你只需要简单两步就可以完成一个 Databasir 应用的构建
3+
[Databasir](https://github.com/vran-dev/databasir) 已经准备好了开箱即用的 Docker Image,你只需要简单三步就可以完成一个 Databasir 应用的部署
44

55
## 环境要求
66

@@ -15,25 +15,36 @@
1515
docker pull vrantt/databasir:latest
1616
```
1717

18-
2. 镜像下载完成以后就可以直接启动了
18+
2. 在 Mysql 中创建数据库 databasir
19+
20+
```sql
21+
create database databasir;
22+
```
23+
24+
3. 启动镜像,需要指定可用的 Mysql 的连接信息
1925

2026
```shell
2127
docker run --name my-databasir -e DATABASIR_DB_URL=127.0.0.1:3306 -e DATABASIR_DB_USERNAME=root -e DATABASIR_DB_PASSWORD=123456 vrantt/databasir:latest -p 8888:8080
2228
```
2329

24-
这里解释一下各个命令参数
2530

26-
- `--name` 代表镜像启动后的名称,你可以随意命名
27-
- `-e` 指定环境变量,databasir 需要依赖 3 个环境变量,所以用 `-e` 指定了 3 个变量,它们分别是
28-
1. DATABASIR_DB_URL 数据库地址
29-
2. DATABASIR_DB_USERNAME 数据库账号名称
30-
3. DATABASIR_DB_PASSWORD 数据库密码
3131

32-
- `-p` 暴露端口,databasir 默认在容器内部开放了 8080 端口,这里将宿主机的 8888 端口映射到了容器的 8080 端口
32+
**docker 启动命令参数说明**
33+
34+
| 参数 | 说明 |
35+
| ---------------------------------- | ------------------------------------------------- |
36+
| --name my-databasir | 启动的镜像名称 |
37+
| -e DATABASIR_DB_URL=127.0.0.1:3306 | 数据库连接地址 |
38+
| -e DATABASIR_DB_USERNAME=root | 数据库连接用户名 |
39+
| -e DATABASIR_DB_PASSWORD=123456 | 数据库连接密码 |
40+
| -p 8888:8080 | 将 databasir 的 8080 端口映射到宿主机的 8888 端口 |
41+
42+
## 登录验证
3343

3444
启动后,Databasir 会默认创建一个超级管理员账户
3545

36-
- 用户名:databasir
37-
- 密码:databasir
46+
- 用户名:`databasir`
47+
- 密码:`databasir`
48+
49+
这时候访问 http://localhost:8888 进入登录页,输入上面的账号和密码即可成功登入,到此就算部署完成
3850

39-
这时候访问 http://localhost:8888 进入登录页,输入上面的账号和密码即可成功登入,到此就算部署完成。
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# 模块和包
2+
3+
## 项目模块
4+
5+
Databasir 基于 Gradle 进行模块管理,当前共有 5 个模块
6+
7+
| 模块名称 | 职责 |
8+
| -------- | ------------------------------------------------------------ |
9+
| api | 所有的接口和定时任务均在该模块定义 |
10+
| common | 定义了项目通用的类,比如加解密工具、业务异常、标准 HTTP 返回类型等 |
11+
| core | 核心业务模块,包含了所有的业务逻辑 |
12+
| dao | 数据访问层,包含了数据库的实体、数据访问对象以及项目模型的 SQL 文件 |
13+
| plugin | jdbc 封装模块,将从 jdbc 获取的数据库元信息转换成 Databasir 的 Java 对象,文档信息的 DIFF 功能也是在该模块内实现 |

docs/_sidebar.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
* [Mock Insert SQL 生成](README/mock-sql/index.md)
2121

2222
* 参与开发
23-
* [构建指南](README/build.md)
24-
23+
* [构建指南](README/develop/build/index.md)
24+
* [模块和包](README/develop/module-and-package/index.md)
25+
2526
* 捐赠
2627

docs/index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,8 @@
3333
<!-- Docsify v4 -->
3434
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
3535
<script src="//unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>
36+
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
37+
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-sql.min.js"></script>
38+
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-properties.min.js"></script>
3639
</body>
3740
</html>

0 commit comments

Comments
 (0)