diff --git a/README.md b/README.md index 3a26416f6fbb5d4a08d5235053eed6f5bda9c679..ca31bac808af53a47a8218f4088c8ee489baf525 100644 --- a/README.md +++ b/README.md @@ -1,157 +1,56 @@ -#
Nebula-Admin
- -
- -
- -![Static Badge](https://img.shields.io/badge/v0.0.1-white?style=flat&logo=nebula&label=nebula-admin&color=%23FF0000) - -![Static Badge](https://img.shields.io/badge/v20.11.1-white?style=flat&logoColor=%23339933&label=nodejs&color=%23339933) ![Static Badge](https://img.shields.io/badge/v10.5.0-white?style=flat&logo=npm&label=npm&color=%23CB3837) ![Static Badge](https://img.shields.io/badge/%40umijs%2Fmax-%5E4.2.9-blue?style=flat) ![Static Badge](https://img.shields.io/badge/antd-5.4.0-green?style=flat) - -
- -#### 介绍 - -基于 umimax 框架,配合 Ant Design UI 组件库搭建的管理系统 - -#### 菜单结构 - -``` -├── 首页 -- Home -├── 组织管理 -- Organization - ├── 组织管理 -- Organization - ├── 部门管理 -- Department - ├── 人员管理 -- Person - ├── 岗位管理 -- Post -├── 系统管理 -- System - ├── 字典管理 -- Dictionary - ├── 角色管理 -- Role - ├── 用户管理 -- User -├── 日志管理 -- Log - ├── 操作日志 -- OperationLog - ├── 登录日志 -- LoginLog - ├── 异常日志 -- ExceptionLog -├── 开发管理 -- Development - ├── 菜单管理 -- Menu - ├── 接口管理 -- Interface -├── 权限演示 -- Permission Demo -``` - -#### 界面图片 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -#### 软件架构 - -``` -"@ant-design/icons": "^5.0.1", -"@ant-design/pro-components": "^2.4.4", -"@umijs/max": "^4.2.9", -"antd": "^5.4.0" -``` - -#### 安装教程 - -`npm` 安装 +# Nebula-Admin + +
Nebula-Admin
+ +## 介绍 + +Nebula-Admin 是一个基于 umiMax 框架构建的管理系统,结合了 Ant Design UI 组件库。 + +## 菜单结构 + +管理系统提供了多个模块,包括开发管理、系统管理、组织架构、日志管理和个人中心等。 + +## 界面图片 + +界面截图可以在项目的 README 文件中找到。 + +## 软件架构 + +该项目使用了以下主要技术和框架: + +- **@ant-design/icons**: "^5.0.1" +- **@ant-design/pro-components**: "^2.4.4" +- **@umijs/max**: "^4.2.9" + +## 安装教程 + +### 使用 npm 安装 1. 安装依赖: `npm install` 2. 启动: `npm run dev` -`yarn` 安装 +### 使用 yarn 安装 1. 安装依赖: `yarn` 2. 启动: `yarn start` -#### 使用说明 - -1. 目前页面数据都是 mock 数据,所以需要自己 git clone 后启动了才能查看 demo -2. .umirc.ts 下配置路由信息和后端服务代理信息 - -``` -proxy: { - '/api': { - 'target': 'http://localhost:8080/', - 'changeOrigin': true, - }, -}, -routes: [ - { - name: '首页', - path: '/home', - icon: 'HomeOutlined', - component: './Home', - access: 'home', - wrappers: ['@/wrappers/auth'], - }, -] -``` - -3. pages 目录下创建页面 -4. services 目录下创建接口 -5. mock 目录下创建 mock 数据(或者启用后端服务) -6. 菜单/按钮的权限信息可以通过`queryAccess`接口获取,也可以改造成自己的方法,具体接口结果参考:mock 数据 - -#### 代码库 - -- GitCode: [https://gitcode.com/NeegixOpensourceGroup/nebula-admin](https://gitcode.com/NeegixOpensourceGroup/nebula-admin) -- Gitee: [https://gitee.com/neegix-opensource-group/nebula-admin](https://gitee.com/neegix-opensource-group/nebula-admin) -- GitHub: [https://github.com/NeegixOpensourceGroup/nebula-admin](https://github.com/NeegixOpensourceGroup/nebula-admin) - -#### 参与贡献 - -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - -#### 后续计划 - -1. 继续完善页面 -2. 启动后端服务 -3. 添加更多功能 - -#### 联系信息 - - - - - - - - - - -
QQ 群: 996598075
+## 使用说明 + +1. 当前页面数据均为模拟数据,需自行克隆仓库并启动以查看演示。 +2. 在 `.umirc.ts` 中配置路由信息和后端服务代理信息。 + +## 代码库 + +项目代码托管在 Gitee 上,可以通过以下链接访问:[Nebula-Admin](https://gitee.com/kushu001/nebula-admin) + +## 参与贡献 + +欢迎参与项目贡献,具体贡献指南请参阅项目文档。 + +## 后续计划 + +项目后续计划包括但不限于功能增强、性能优化和用户体验改进。 + +## 联系信息 + +如需联系项目维护者,请通过 Gitee 私信或项目讨论区进行沟通。 \ No newline at end of file