mirror of
https://github.com/chansee97/nova-admin.git
synced 2025-04-06 03:57:54 +08:00
docs: perfect readme
This commit is contained in:
chansee97
parent
e81c0197df
commit
c459bf4c43
38
README.md
38
README.md
@ -16,27 +16,29 @@
|
||||
|
||||
## Introduction
|
||||
|
||||
[Nova-admin](https://github.com/chansee97/nova-admin) A free and open-source template for middle platform/back-end based on Vue3, Vite4, Typescript, pinia, Naive UI, and Vue-Router to help improve the development efficiency of middle platform/back-end
|
||||
[Nova-admin](https://github.com/chansee97/nova-admin) is a clean and concise back-end management template based on Vue3, Vite5, Typescript, and Naive UI. It implements complete functionality in a simple way, while also considering code standards, readability, and avoiding excessive encapsulation to facilitate secondary development.
|
||||
|
||||
## Features
|
||||
|
||||
- **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
|
||||
- **Authority Control** - Perfect front and back-end authority management solution
|
||||
- **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
|
||||
- **Theme Configuration** - Dark Theme Adaptation
|
||||
- **Code Specification** - Only perform eslint verification at commit time, no too many restrictions, easier development
|
||||
- Developed based on the latest technology stack including Vue3, Vite5, TypeScript, NaiveUI, Unocss, etc.
|
||||
- Based on [alova](https://alova.js.org/) encapsulation and configuration, providing unified response handling and multi-scenario capabilities.
|
||||
- Comprehensive front-end and back-end permission management solution.
|
||||
- Supports local static routes and dynamically generated routes from the back end, with easy route configuration.
|
||||
- Secondary encapsulation of commonly used components to meet basic work requirements.
|
||||
- Dark theme adaptation, maintaining the Naive style for interface aesthetics.
|
||||
- Only performs eslint validation during submission without excessive restrictions for simpler development.
|
||||
- Flexible and configurable interface style layout.
|
||||
|
||||
## Project preview
|
||||
|
||||
- [Nova-Admin preview](https://admin-nova.vercel.app/)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Repo
|
||||
|
||||
@ -49,7 +51,7 @@
|
||||
|
||||
## Install and use
|
||||
|
||||
The local development environment is recommended to use pnpm 8.x, Node.js 16.x
|
||||
The local development environment is recommended to use pnpm 8.x, Node.js 18.x
|
||||
|
||||
```bash
|
||||
# install dependencies
|
||||
@ -72,9 +74,11 @@ This project uses ApiFox for interface mock, check the online documentation for
|
||||
|
||||
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.
|
||||
|
||||
| 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>|
|
||||
| Q-Group | wechat-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/nova-admin/wx-group.png" width=170>|<img src="https://cdn.jsdelivr.net/gh/chansee97/static/wechat.png" width=170>|
|
||||
|
||||
> The WeChat group QR code is invalid, please add me as a friend.
|
||||
|
||||
## Contribution
|
||||
|
||||
|
||||
@ -16,27 +16,29 @@
|
||||
|
||||
## 介绍
|
||||
|
||||
[Nova-admin](https://github.com/chansee97/nova-admin)一个基于Vue3、Vite4、Typescript、pinia、Naive UI、Vue-Router的后台管理免费开源模板，助力提高中后台开发效率
|
||||
[Nova-admin](https://github.com/chansee97/nova-admin)是一个基于Vue3、Vite5、Typescript、Naive UI, 简洁干净后台管理模板，用简单的方式实现完整功能，并尽可能的考虑代码规范，易读易理解无过度封装，方便二次开发。
|
||||
|
||||
## 特性
|
||||
|
||||
- **最新流行技术栈** - 基于Vue3、Vite、TypeScript、NaiveUI、Pinia等最新技术栈开发
|
||||
- **网络请求功能封装** - 基于[alova](https://alova.js.org/)封装和配置，统一的响应处理和多场景能力
|
||||
- **权限控制** - 完善的前后端权限管理方案
|
||||
- **路由系统** - 支持本地静态路由和后台返回动态路由，路由简单易配置
|
||||
- **组件封装** - 对日常使用频率较高的组件二次封装,满足基础工作需求
|
||||
- **主题配置** - 黑暗主题适配
|
||||
- **代码规范** - 仅在提交时进行eslint校验，没有过多限制，开发更简便
|
||||
- 基于Vue3、Vite5、TypeScript、NaiveUI、Unocss等最新技术栈开发
|
||||
- 基于[alova](https://alova.js.org/)封装和配置，提供统一的响应处理和多场景能力
|
||||
- 完善的前后端权限管理方案
|
||||
- 支持本地静态路由和后台返回动态路由，路由简单易配置
|
||||
- 对日常使用频率较高的组件二次封装,满足基础工作需求
|
||||
- 黑暗主题适配, 界面样式保持navie风格
|
||||
- 仅在提交时进行eslint校验，没有过多限制，开发更简便
|
||||
- 界面样式布局灵活可配置
|
||||
|
||||
## 项目预览
|
||||
|
||||
- [Nova-Admin 预览](https://admin-nova.vercel.app/)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 代码仓库
|
||||
|
||||
@ -49,7 +51,7 @@
|
||||
|
||||
## 安装使用
|
||||
|
||||
本地开发环境建议使用 pnpm 8.x 、Node.js 16.x
|
||||
本地开发环境建议使用 pnpm 8.x 、Node.js 18.x
|
||||
|
||||
```bash
|
||||
# install dependencies
|
||||
@ -70,11 +72,13 @@ pnpm build
|
||||
|
||||
## 学习交流
|
||||
|
||||
Nova-Admin 是完全开源免费的项目，目前仍然在优化迭代中，旨在帮助开发者更方便地进行中大型管理系统开发，有使用问题欢迎在QQ交流群内提问。
|
||||
Nova-Admin 是完全开源免费的项目，目前仍然在优化迭代中，旨在帮助开发者更方便地进行中大型管理系统开发，有使用问题欢迎在交流群内提问。
|
||||
|
||||
| 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>|
|
||||
| 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/nova-admin/wx-group.png" width=170>|<img src="https://cdn.jsdelivr.net/gh/chansee97/static/wechat.png" width=170>|
|
||||
|
||||
> 微信群二维码失效请加我为好友
|
||||
|
||||
## 贡献
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user