116 lines
3.4 KiB
Markdown
116 lines
3.4 KiB
Markdown
<p align="center">
|
||
<a href="https://github.com/zclzone/vue-naive-admin">
|
||
<img alt="Vue Naive Admin Logo" width="200" src="https://assets.qszone.com/images/logo_qs.svg">
|
||
</a>
|
||
</p>
|
||
<p align="center">
|
||
<a href="https://github.com/zclzone/vue-naive-admin/actions"><img allt="checks" src="https://badgen.net/github/checks/zclzone/vue-naive-admin"/></a>
|
||
<a href="https://github.com/zclzone/vue-naive-admin"><img allt="stars" src="https://badgen.net/github/stars/zclzone/vue-naive-admin"/></a>
|
||
<a href="https://github.com/zclzone/vue-naive-admin"><img allt="forks" src="https://badgen.net/github/forks/zclzone/vue-naive-admin"/></a>
|
||
<a href="./LICENSE"><img allt="MIT License" src="https://badgen.net/github/license/zclzone/vue-naive-admin"/></a>
|
||
</p>
|
||
|
||
<p align='center'>
|
||
<b>English</b> |
|
||
<a href="https://github.com/zclzone/vue-naive-admin/blob/main/README.zh-CN.md">简体中文</a>
|
||
</p>
|
||
|
||
### Introduction
|
||
|
||
[Vue Naive Admin](https://github.com/zclzone/vue-naive-admin) is a **completely open source free and commercially allowed ** admin template，Based on the latest technology stack of front-end such as `Vue3、Vite2、Pinia、Unocss and Naive UI`. Compared with other more popular backend management templates, this project is more concise, lightweight, fresh style, very low learning costs, ideal for small and medium-sized projects or personal projects.
|
||
|
||
### Features
|
||
|
||
- 🍒 Integrated [Naive UI](https://www.naiveui.com)，recommended by Evan You.
|
||
- 🍑 Integrated login, logout and permission verification.
|
||
- 🍐 Integrated multi-environment configuration, dev, test, production and github pages environments.
|
||
- 🍎 Integrated `eslint + prettier`.
|
||
- 🍌 Integrated `husky + commitlint`.
|
||
- 🍉 Integrated `Mock`.
|
||
- 🍍 Integrated `pinia`，lightweight, simple and easy to use alternative to vuex.
|
||
- 📦 Integrated `unplugin` auto import.
|
||
- 🤹 Integrated `iconify` icon，support custom svg icons.
|
||
- 🍇 Integrated `unocss`.
|
||
|
||
### Preview
|
||
|
||
[https://template.qszone.com](https://template.qszone.com)
|
||
|
||
[https://zclzone.github.io/vue-naive-admin](https://zclzone.github.io/vue-naive-admin)
|
||
|
||
### Docs
|
||
|
||
[Vue Naive Admin Docs](https://zclzone.github.io/vue-naive-admin-docs)
|
||
|
||
|
||
### Getting Started
|
||
|
||
```shell
|
||
# Recommended setup git autocrlf 为 false
|
||
git config --global core.autocrlf false
|
||
|
||
# Clone Project
|
||
git clone https://github.com/zclzone/vue-naive-admin.git
|
||
|
||
cd vue-naive-admin
|
||
|
||
# Install dependencies(Recommended use pnpm: https://pnpm.io/zh/installation)
|
||
npm i -g pnpm # Installed and can be ignored
|
||
pnpm i # or npm i
|
||
|
||
# Start
|
||
pnpm dev
|
||
```
|
||
|
||
### Build and Release
|
||
|
||
```shell
|
||
# Test Environment
|
||
pnpm build:test
|
||
|
||
# Github Environment
|
||
pnpm build:github
|
||
|
||
# Prod Environment
|
||
pnpm build
|
||
```
|
||
|
||
### Other
|
||
|
||
```shell
|
||
# eslint check
|
||
pnpm lint
|
||
|
||
# eslint check and fix
|
||
pnpm lint:fix
|
||
|
||
# Preview（Need to build first）
|
||
pnpm preview
|
||
|
||
# Commit（husky+commitlint）
|
||
pnpm cz
|
||
```
|
||
|
||
### TS version: Qs Admin
|
||
|
||
#### source code
|
||
|
||
- gitub: [https://github.com/zclzone/qs-admin](https://github.com/zclzone/qs-admin)
|
||
- gitee: [https://gitee.com/zclzone/qs-admin-ts](https://gitee.com/zclzone/qs-admin-ts)
|
||
|
||
#### preview
|
||
|
||
- [https://admin.qszone.com](https://admin.qszone.com)
|
||
- [https://zclzone.github.io/qs-admin](https://zclzone.github.io/qs-admin)
|
||
|
||
### Communication group & About the author
|
||
|
||
<a href="https://blog.qszone.com/about/">
|
||
<img src="https://assets.qszone.com/images/about.png" style="max-width: 400px" />
|
||
</a>
|
||
|
||
|
||
|
||
|
||
|