mirror of
https://github.com/vran-dev/databasir.git
synced 2025-08-10 22:34:58 +08:00
Feature/readme (#29)
* feat: update frontend resource * fix: oauth2 login callback exception * feat: update README
This commit is contained in:
24
README.md
24
README.md
@@ -6,20 +6,22 @@
|
||||
- [部署指引](README/deploy.md)
|
||||
- [构建指引](README/build.md)
|
||||
|
||||
## 快速上手
|
||||
|
||||
- [Databasir 之 Github 一键登录(OAuth2)配置](README/github-oauth2/github-oauth2.md)
|
||||
- [Databasir 之 Gitlab 一键登录(OAuth2)配置](README/gitlab-oauth2/gitlab-oauth2.md)
|
||||
|
||||
## 简介
|
||||
|
||||
**Databasir** 是一款集中式的数据库文档管理工具,提供了自动化、版本化、扁平化的数据库文档管理能力,主要功能如下
|
||||
|
||||
1. 支持多种数据库
|
||||
1. 自动或手动同步数据库 Schema 并生成文档
|
||||
2. 项目 Schema 历史版本文档查看
|
||||
3. 项目文档导出,提供 markdown、excel(研发中) 等格式
|
||||
4. 团队管理、成员管理一应俱全,扁平化的权限管理模式
|
||||
5. 安全系数高:数据库密码加密存储,存储后不会再返回前端
|
||||
|
||||
|
||||
1. 理论上支持所有拥有 JDBC 驱动的数据库,目前 mysql、postgresql 可以开箱即用
|
||||
2. 支持 github / github-enterprise / gitlab 的 OAuth2 登录,全图形化配置
|
||||
3. 支持手动、定时同步数据库结构并自动生成可读性优秀的文档、UML 图
|
||||
4. 支持多文件格式导出,如 markdown
|
||||
5. 历史模型版本化,一键查看历史版本
|
||||
6. 多人协作字段批注,不再害怕没有注释
|
||||
7. 扁平化的团队管理模式,灵活适应不同团队组织架构
|
||||
|
||||
## 支持数据库
|
||||
|
||||
@@ -29,14 +31,16 @@
|
||||
4. - [ ] SqlServer
|
||||
|
||||
|
||||
|
||||
## 功能规划
|
||||
|
||||
- [x] 用户操作审计日志
|
||||
- [x] 文档自动同步日志
|
||||
- [ ] Excel 文档导出
|
||||
- [x] Markdown 文档导出
|
||||
|
||||
- [x] Github OAuth2 登录模式
|
||||
- [x] Gitlab OAuth2 登录模式
|
||||
- [x] 模型 UML 生成
|
||||
- [ ] UML 图片导出
|
||||
|
||||
|
||||
## 展示
|
||||
|
Reference in New Issue
Block a user