Skip to content

behappy-project/behappy-screw-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Apr 27, 2023
5fcadd6 · Apr 27, 2023

History

70 Commits
Apr 25, 2023
Jun 8, 2022
Aug 26, 2022
Apr 27, 2023
Apr 27, 2023
Apr 27, 2023
Aug 19, 2022
Aug 26, 2022
Sep 27, 2022
Nov 14, 2022
Apr 25, 2023
Aug 10, 2022
Apr 25, 2023
Apr 27, 2023
Apr 27, 2023

Repository files navigation

欢迎“一键三连[watch,fork,star]”

如果有对该项目感兴趣的小伙伴,可以联系我,大家一起研究

技术沟通群

背景

在日常开发中, 伴随着许许多多的文档

业务文档, 需求文档, 开发文档 等等

随着业务范围逐渐扩大, 项目逐渐增多, 数据库逐渐开始变得难以管理

所以数据库文档也开始变得重要起来

目标

整合现有数据库(支持mysql/clickhouse), 做好文档规范

新人辅导向, 该平台可以更直观的查看数据库关系

方便开发人员的定期review

部署方式(目前仅支持容器化部署)

  • Docker-compose部署
# 下载./docker-compose文件,修改environment部分。具体含义见注释,然后执行以下命令
docker-compose up -d
  • Docker部署
# 执行以下命令(记得指定环境变量)
docker run -d --name behappy-screw-doc --privileged=true --restart=no -p 8999:8080 -v /opt/dbdoc/doc:/user/src/app/doc wangxiaowu950330/behappy-screw-doc:latest

使用方式

大体支持两种角色,一种ROLE_ADMIN.另一种是ROLE_XXX
ADMIN用于管理数据库,用户和角色信息
XXX为普通角色,用于查看所分配数据库信息

先配置数据源信息

img.png

配置数据库信息

img.png

创建数据库/同步数据库

img.png

对应角色分配数据库

img.png

admin账户执行初始化文档

img.png

历史回溯功能

此功能用于查询当前数据库的更新迭代信息

img.png

image.png

访问

http://xxx:8999/
账户: admin
密码: admin
  • mysql文档管理
  • clickhouse文档管理
  • 角色划分
  • 容器化支持
  • 数据更改后,可进行历史回溯
  • 手动初始化数据库数据改为自动初始化
  • 支持ldap登录

注: 当前项目支持两种数据库, mysql和clickhouse, 但clickhouse因为screw原作者还未合代码, 所以如果是需要本地开发的话, 需要手动执行下此命令将jar包安装到本地库

参考: https://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html

mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile="lib/screw-core-1.0.6-SNAPSHOT.jar" -DpomFile="lib/screw-1.0.6-SNAPSHOT.pom"
cp lib/screw-core-1.0.6-SNAPSHOT.pom ~/.m2/repository/cn/smallbun/screw/screw/1.0.6-SNAPSHOT/screw-1.0.6-SNAPSHOT.pom
mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile="lib/screw-core-1.0.6-SNAPSHOT.jar" -DpomFile="lib/screw-core-1.0.6-SNAPSHOT.pom"