docs: perfect readme

This commit is contained in:
chansee97 2024-03-18 12:42:57 +08:00
parent dac65d9182
commit f05c289920
2 changed files with 36 additions and 8 deletions

View File

@ -23,7 +23,7 @@
- **Latest popular technology stack** - Developed based on the latest technology stack such as Vue3, Vite, TypeScript, NaiveUI, Pinia, etc - **Latest popular technology stack** - Developed based on the latest technology stack such as Vue3, Vite, TypeScript, NaiveUI, Pinia, etc
- **Network request function encapsulation** - Based on [alova](https://alova.js.org/) encapsulation and configuration, unified response processing and multi-scenario capabilities - **Network request function encapsulation** - Based on [alova](https://alova.js.org/) encapsulation and configuration, unified response processing and multi-scenario capabilities
- **Authority Control** - Perfect front and back-end authority management solution - **Authority Control** - Perfect front and back-end authority management solution
- **Routing system** - Supports local static and dynamic routing - **Routing system** - Support local static routing and background return dynamic routing, routing is simple and easy to configure
- **Component packaging** - Secondary packaging of components with high frequency of daily use to meet basic workrequirements - **Component packaging** - Secondary packaging of components with high frequency of daily use to meet basic workrequirements
- **Theme Configuration** - Dark Theme Adaptation - **Theme Configuration** - Dark Theme Adaptation
- **Code Specification** - Only perform eslint verification at commit time, no too many restrictions, easier development - **Code Specification** - Only perform eslint verification at commit time, no too many restrictions, easier development
@ -38,6 +38,11 @@
![image.png](https://s2.loli.net/2023/10/10/cy8nrv1kSLpjCT9.png) ![image.png](https://s2.loli.net/2023/10/10/cy8nrv1kSLpjCT9.png)
![image.png](https://s2.loli.net/2023/10/10/rACdG2fUI6oJN7H.png) ![image.png](https://s2.loli.net/2023/10/10/rACdG2fUI6oJN7H.png)
## repo
- [Gitee](https://gitee.com/chansee97/nova-admin)
- [Github](https://github.com/chansee97/nova-admin)
## related projects ## related projects
- [Nova-admin-nest](https://github.com/chansee97/nove-admin-nest) (under development) Nova-Admin supporting background project based on TS, NestJs, typeorm - [Nova-admin-nest](https://github.com/chansee97/nove-admin-nest) (under development) Nova-Admin supporting background project based on TS, NestJs, typeorm
@ -58,21 +63,30 @@ pnpm build
``` ```
## 接口文档
This project uses ApiFox for interface mock, check the online documentation for more interface details
[online aipfox docs](https://apifox.com/apidoc/shared-2b1abeb5-6e78-425e-a4ff-d7277ae83bf0)
## learn to communicate ## learn to communicate
Nova-Admin is a completely open-source and free project. It is still being optimized and iterated. It is designed to help developers more conveniently develop medium and large management systems. If you have any questions, please ask questions in the QQ exchange group. Nova-Admin is a completely open-source and free project. It is still being optimized and iterated. It is designed to help developers more conveniently develop medium and large management systems. If you have any questions, please ask questions in the QQ exchange group.
![image.png](https://s2.loli.net/2023/08/26/PQJjURT7V46Lw2d.png) | Q-Group | wechat |
| :--: |:--: |
| <img src="https://cdn.jsdelivr.net/gh/chansee97/static/nova-admin/q-group.png" width=170> | <img src="https://cdn.jsdelivr.net/gh/chansee97/static/wechat.png" width=170>|
## contribution ## contribution
If you find any issues or have suggestions for improvement, please create an issue or submit a PR. We welcome your contributions! If you find any issues or have suggestions for improvement, please create an [issue](nova-admin/issues/new) or submit a PR. We welcome your contributions!
## support ## support
If you feel that this project is helpful for your work or study, please help me order a ✨ Star, which will be a great encouragement and support for me, or you can buy me a cup of coffee below If you feel that this project is helpful for your work or study, please help me order a ✨ Star, which will be a great encouragement and support for me, or you can buy me a cup of coffee below
![sponsor](https://cdn.jsdelivr.net/gh/chansee97/static/sponsor.png) | wechat | alipay |
| :--: |:--: |
| <img src="https://cdn.jsdelivr.net/gh/chansee97/static/sponsor-wechat.png" width=170> | <img src="https://cdn.jsdelivr.net/gh/chansee97/static/sponsor-alipay.png" width=170>|
## [Contributors](https://github.com/chansee97/nova-admin/graphs/contributors) ## [Contributors](https://github.com/chansee97/nova-admin/graphs/contributors)

View File

@ -23,7 +23,7 @@
- **最新流行技术栈** - 基于Vue3、Vite、TypeScript、NaiveUI、Pinia等最新技术栈开发 - **最新流行技术栈** - 基于Vue3、Vite、TypeScript、NaiveUI、Pinia等最新技术栈开发
- **网络请求功能封装** - 基于[alova](https://alova.js.org/)封装和配置,统一的响应处理和多场景能力 - **网络请求功能封装** - 基于[alova](https://alova.js.org/)封装和配置,统一的响应处理和多场景能力
- **权限控制** - 完善的前后端权限管理方案 - **权限控制** - 完善的前后端权限管理方案
- **路由系统** - 支持本地静态路由和动态路由 - **路由系统** - 支持本地静态路由和后台返回动态路由,路由简单易配置
- **组件封装** - 对日常使用频率较高的组件二次封装,满足基础工作需求 - **组件封装** - 对日常使用频率较高的组件二次封装,满足基础工作需求
- **主题配置** - 黑暗主题适配 - **主题配置** - 黑暗主题适配
- **代码规范** - 仅在提交时进行eslint校验没有过多限制开发更简便 - **代码规范** - 仅在提交时进行eslint校验没有过多限制开发更简便
@ -38,6 +38,11 @@
![image.png](https://s2.loli.net/2023/10/10/cy8nrv1kSLpjCT9.png) ![image.png](https://s2.loli.net/2023/10/10/cy8nrv1kSLpjCT9.png)
![image.png](https://s2.loli.net/2023/10/10/rACdG2fUI6oJN7H.png) ![image.png](https://s2.loli.net/2023/10/10/rACdG2fUI6oJN7H.png)
## 代码仓库
- [Gitee](https://gitee.com/chansee97/nova-admin)
- [Github](https://github.com/chansee97/nova-admin)
## 相关项目 ## 相关项目
- [Nova-admin-nest](https://github.com/chansee97/nove-admin-nest) (开发中)基于TS, NestJs, typeorm的Nova-Admin配套后台项目 - [Nova-admin-nest](https://github.com/chansee97/nove-admin-nest) (开发中)基于TS, NestJs, typeorm的Nova-Admin配套后台项目
@ -58,21 +63,30 @@ pnpm build
``` ```
## 接口文档
本项目使用ApiFox进行接口mock查看在线文档以了解更多接口详情
[在线apifox文档](https://apifox.com/apidoc/shared-2b1abeb5-6e78-425e-a4ff-d7277ae83bf0)
## 学习交流 ## 学习交流
Nova-Admin 是完全开源免费的项目目前仍然在优化迭代中旨在帮助开发者更方便地进行中大型管理系统开发有使用问题欢迎在QQ交流群内提问。 Nova-Admin 是完全开源免费的项目目前仍然在优化迭代中旨在帮助开发者更方便地进行中大型管理系统开发有使用问题欢迎在QQ交流群内提问。
![image.png](https://s2.loli.net/2023/08/26/PQJjURT7V46Lw2d.png) | Q群 | 微信 |
| :--: |:--: |
| <img src="https://cdn.jsdelivr.net/gh/chansee97/static/nova-admin/q-group.png" width=170> | <img src="https://cdn.jsdelivr.net/gh/chansee97/static/wechat.png" width=170>|
## 贡献 ## 贡献
如果您发现了任何问题或有改进建议请创建一个issue或提交一个PR。我们欢迎您的贡献 如果您发现了任何问题或有改进建议,请创建一个[issue](nova-admin/issues/new)或提交一个PR。我们欢迎您的贡献
## 支持 ## 支持
如果感觉本项目对你工作或学习有帮助请帮我点一个✨Star,这将是对我极大的鼓励与支持, 也可以在下方请我喝一杯咖啡 如果感觉本项目对你工作或学习有帮助请帮我点一个✨Star,这将是对我极大的鼓励与支持, 也可以在下方请我喝一杯咖啡
![sponsor](https://cdn.jsdelivr.net/gh/chansee97/static/sponsor.png) | 微信 | 支付宝 |
| :--: |:--: |
| <img src="https://cdn.jsdelivr.net/gh/chansee97/static/sponsor-wechat.png" width=170> | <img src="https://cdn.jsdelivr.net/gh/chansee97/static/sponsor-alipay.png" width=170>|
## [贡献者](https://github.com/chansee97/nova-admin/graphs/contributors) ## [贡献者](https://github.com/chansee97/nova-admin/graphs/contributors)