mirror of
https://github.com/jekip/naive-ui-admin.git
synced 2026-02-04 13:42:27 +08:00
140 lines
4.5 KiB
Markdown
140 lines
4.5 KiB
Markdown
## 简介
|
||
|
||
Naive Ui Admin 是一个免费开源的中后台模版，使用了最新的`vue3`,`vite2`,`TypeScript`等主流技术开发，开箱即用的中后台前端解决方案，也可用于学习参考。
|
||
|
||
## 特性
|
||
- **最新技术栈**：使用 Vue3/vite2 等前端前沿技术开发
|
||
- **TypeScript**: 应用程序级 JavaScript 的语言
|
||
- **主题**：可配置的主题
|
||
- **Mock 数据** 内置 Mock 数据方案
|
||
- **权限** 内置完善的动态路由权限生成方案
|
||
- **组件** 二次封装了多个常用的组件
|
||
|
||
### 页面功能
|
||
#### 系统看板
|
||
- [x] 主控台
|
||
- [ ] 监控页
|
||
- [x] 工作台
|
||
- [x] 表单页面
|
||
- [x] 列表页面
|
||
- [x] 异常页面
|
||
- [x] 结果页面
|
||
- [x] 设置页面
|
||
- [x] 系统设置
|
||
- [x] 菜单权限
|
||
- [x] 角色权限
|
||
|
||
### 页面组件
|
||
#### ProTable
|
||
- [x] 基础表格
|
||
- [x] 上传图片
|
||
- [x] 滑块验证码
|
||
- 持续开发中...
|
||
|
||
## 在线预览
|
||
- [naive-ui-admin](https://jekip.github.io)
|
||
|
||
账号：admin，密码：123456
|
||
|
||
## 文档
|
||
|
||
[文档地址](https://github.com/jekip/naive-ui-admin) - 待完善
|
||
|
||
## 准备
|
||
|
||
- [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境
|
||
- [Vite](https://vitejs.dev/) - 熟悉 vite 特性
|
||
- [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法
|
||
- [TypeScript](https://www.typescriptlang.org/) - 熟悉`TypeScript`基本语法
|
||
- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法
|
||
- [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用
|
||
- [Naive-ui-admin](https://www.naiveui.com/) - ui 基本使用
|
||
- [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法
|
||
|
||
## 安装使用
|
||
|
||
- 获取项目代码
|
||
|
||
```bash
|
||
git clone https://github.com/jekip/naive-ui-admin.git
|
||
```
|
||
|
||
- 安装依赖
|
||
|
||
```bash
|
||
cd naive-ui-admin
|
||
|
||
yarn install
|
||
|
||
```
|
||
|
||
- 运行
|
||
|
||
```bash
|
||
yarn dev
|
||
```
|
||
|
||
- 打包
|
||
|
||
```bash
|
||
yarn build
|
||
```
|
||
|
||
## 更新日志
|
||
|
||
[CHANGELOG](./CHANGELOG.md)
|
||
|
||
## 感谢
|
||
[@Vben](https://github.com/anncwb/vue-vben-admin) 借鉴 vue-vben-admin 实现的骨架，同时也使用作者开发的 vite 插件，非常感谢作者。
|
||
|
||
|
||
## 如何贡献
|
||
|
||
非常欢迎你的加入！[提一个 Issue](https://github.com/jekip/naive-ui-admin/issues) 或者提交一个 Pull Request。
|
||
|
||
**Pull Request:**
|
||
|
||
1. Fork 代码!
|
||
2. 创建自己的分支: `git checkout -b feat/xxxx`
|
||
3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
|
||
4. 推送您的分支: `git push origin feat/xxxx`
|
||
5. 提交`pull request`
|
||
|
||
## Git 贡献提交规范
|
||
|
||
- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
|
||
|
||
- `feat` 增加新功能
|
||
- `fix` 修复问题/BUG
|
||
- `style` 代码风格相关无影响运行结果的
|
||
- `perf` 优化/性能提升
|
||
- `refactor` 重构
|
||
- `revert` 撤销修改
|
||
- `test` 测试相关
|
||
- `docs` 文档/注释
|
||
- `chore` 依赖更新/脚手架配置修改等
|
||
- `workflow` 工作流改进
|
||
- `ci` 持续集成
|
||
- `types` 类型定义文件更改
|
||
- `wip` 开发中
|
||
|
||
## 浏览器支持
|
||
|
||
本地开发推荐使用`Chrome 80+` 浏览器
|
||
|
||
支持现代浏览器, 不支持 IE
|
||
|
||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
|
||
| :-: | :-: | :-: | :-: | :-: |
|
||
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
||
|
||
## 维护者
|
||
[@Ah jung](https://github.com/jekip)
|
||
|
||
## 交流
|
||
|
||
`Naive Ui Admin` 是完全开源免费的项目，在帮助开发者更方便地进行中大型管理系统开发，同时也提供 QQ 交流群使用问题欢迎在群内提问。
|
||
|
||
- QQ 群 `328347666`
|
||
|