docs: 完善 README 文档

This commit is contained in:
Charles7c 2023-11-03 23:54:56 +08:00
parent d41e01c388
commit dd47265e97

View File

@ -32,6 +32,8 @@ ContiNew Admin Continue New Admin中后台管理框架/脚手架,持续
| GitHub | https://github.com/Charles7c/continew-admin |
| Gitee码云 | https://gitee.com/Charles7c/continew-admin |
<img src="https://repobeats.axiom.co/api/embed/be43df158b86ce201cd2b7e0e6c8a85740149b7e.svg" alt="Alt" title="Repobeats github analytics image" />
## 反馈交流
💬 欢迎各位小伙伴儿扫描下方二维码加好友,备注 `cnadmin`,拉你进群,探讨技术、提提需求~
@ -48,7 +50,7 @@ ContiNew Admin Continue New Admin中后台管理框架/脚手架,持续
</div>
<details>
<summary>无加群意愿 😖</summary>
<summary>无加群意愿</summary>
💬 如无加群意愿,欢迎在 <a href="https://github.com/Charles7c/continew-admin/discussions" target="_blank">Discussions</a> 中进行交流探讨~ 🍻
</details>
@ -72,12 +74,13 @@ ContiNew Admin Continue New Admin中后台管理框架/脚手架,持续
> **Note**
> 更多功能和优化正在赶来💦,最新项目计划和进展请关注 [GitHub Project](https://github.com/Charles7c/continew-admin/projects) 和 [CHANGELOG.md](https://github.com/Charles7c/continew-admin/blob/dev/CHANGELOG.md)。
- 用户管理:提供用户的相关配置,新增用户后,默认密码为 123456且支持第三方账号登录、邮箱登录、手机号登录可在个人中心灵活配置
- 个人中心:支持基础信息修改、安全设置(密码修改、邮箱绑定、手机号绑定、第三方账号绑定/解绑)、头像裁剪上传、个人操作日志查看
- 用户管理:提供用户的相关配置,新增用户后,默认密码为 123456
- 部门管理:可配置系统组织架构,树形表格展示
- 角色管理:对权限与菜单进行分配,可根据部门设置角色的数据权限
- 菜单管理:已实现菜单动态路由,后端可配置化,支持多级菜单
- 公告管理:提供公告的发布、查看和删除等功能。管理员可以在后台发布公告,并可以设置公告的生效时间、终止时间,以 markdown-it 为内核渲染 Markdown 格式内容显示
- 消息管理:提供消息中心功能,暂时仅支持系统消息管理
- 消息管理:提供消息查看、标记已读、全部已读、删除等功能(适配对接导航栏站内信功能)
- 字典管理:提供对系统公用数据字典的维护,例如:公告类型,支持字典标签背景色和排序等配置
- 系统配置提供修改系统标题、Logo、favicon 等基础配置功能,以方便用户系统与其自身品牌形象保持一致(暂未开放高级配置)
- 代码生成:提供根据数据库表自动生成相应的前后端 CRUD 代码的功能
@ -220,7 +223,7 @@ pnpm dev
## 核心技术栈
| 名称 | 版本 | 简介 |
|:----------------------------------------------------------------------------------------------------------------------------------|:-------------| :----------------------------------------------------------- |
| :----------------------------------------------------------- |:-------------| :----------------------------------------------------------- |
| <a href="https://cn.vuejs.org/" target="_blank">Vue</a> | 3.3.4 | 渐进式 JavaScript 框架,易学易用,性能出色,适用场景丰富的 Web 前端框架。 |
| <a href="https://www.typescriptlang.org/zh/" target="_blank">TypeScript</a> | 4.9.5 | TypeScript 是微软开发的一个开源的编程语言,通过在 JavaScript 的基础上添加静态类型定义构建而成。 |
| <a href="https://arco.design/vue/docs/start" target="_blank">Arco Design Vue</a> | 2.52.0 | 字节跳动推出的前端 UI 框架,样式美观,组件丰富。 |
@ -273,7 +276,9 @@ continew-admin # 全局通用项目配置及依赖版本管理
│ └─ resources # 工程配置目录
│ ├─ db.changelog # 数据库脚本文件
│ │ ├─ v1.0.0 # v1.0.0 版本数据库脚本文件
│ │ └─ v1.1.0 # v1.1.0 版本数据库脚本文件
│ │ ├─ v1.1.0 # v1.1.0 版本数据库脚本文件
│ │ ├─ v1.2.0 # v1.2.0 版本数据库脚本文件
│ │ └─ v1.3.0 # v1.3.0 版本数据库脚本文件
│ └─ templates # 模板文件
│ └─ mail # 邮件模板
├─ continew-admin-monitor # 系统监控模块(存放系统监控模块相关功能,例如:日志管理、服务监控等)
@ -483,7 +488,7 @@ ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大
感谢参与贡献的每一位小伙伴!(以下排名不分先后)
<a href="https://github.com/Charles7c/continew-admin/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Charles7c/continew-admin" />
<img src="https://opencollective.com/continew-admin/contributors.svg?width=890&button=false" alt="contributors" />
</a>
### 特别鸣谢