mirror of
https://github.com/chansee97/nova-admin.git
synced 2025-04-05 19:41:59 +08:00
107 lines
4.4 KiB
Markdown
107 lines
4.4 KiB
Markdown
<div align="center">
|
|
<img src="https://s2.loli.net/2023/10/27/WzQ4JLNV5epKh6X.png" style="width:150px"/>
|
|
<h1>Nova Admin</h1>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<img src="https://img.shields.io/github/license/chansee97/nova-admin"/>
|
|
<img src="https://img.shields.io/github/stars/chansee97/nova-admin"/>
|
|
<img src="https://img.shields.io/github/forks/chansee97/nova-admin"/>
|
|
</div>
|
|
|
|
<div align='center'>
|
|
|
|
English | [中文](./README.zh-CN.md)
|
|
</div>
|
|
|
|
## Introduction
|
|
|
|
[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.
|
|
|
|
- [Nova-Admin preview](https://nova-admin-site.netlify.app/)
|
|
- [Nova-Admin docs](https://nova-admin-docs.netlify.app/)
|
|
|
|
## Features
|
|
|
|
- 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
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Repo
|
|
|
|
- [Gitee](https://gitee.com/chansee97/nova-admin)
|
|
- [Github](https://github.com/chansee97/nova-admin)
|
|
|
|
## Related projects
|
|
|
|
- [Nova-admin-nest](https://github.com/chansee97/nove-admin-nest) (under development) Nova-Admin supporting background project based on TS, NestJs, typeorm
|
|
|
|
## Install and use
|
|
|
|
The local development environment is recommended to use pnpm 8.x, Node.js 18.x
|
|
|
|
```bash
|
|
# install dependencies
|
|
pnpm i
|
|
|
|
# Run
|
|
pnpm dev
|
|
|
|
# Build product
|
|
pnpm build
|
|
|
|
```
|
|
|
|
## Interface document
|
|
|
|
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
|
|
|
|
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-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
|
|
|
|
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
|
|
|
|
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
|
|
|
|
| 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)
|
|
|
|
|
|
|
|
## Star History
|
|
|
|
[](https://star-history.com/#chansee97/nova-admin&Date)
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|