2022-04-10 14:06:06 +08:00
< 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 >
2022-07-29 16:48:58 +08:00
< p align = 'center' >
< b > English< / b > |
< a href = "https://github.com/zclzone/vue-naive-admin/blob/main/README.zh-CN.md" > 简体中文< / a >
< / p >
### Introduction
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
[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.
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
### Features
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
- 🍒 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` .
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
### Preview
2022-02-14 14:05:40 +08:00
2022-07-11 16:07:07 +08:00
[https://template.qszone.com ](https://template.qszone.com )
2022-02-14 14:05:40 +08:00
2022-07-11 16:07:07 +08:00
[https://zclzone.github.io/vue-naive-admin ](https://zclzone.github.io/vue-naive-admin )
2022-04-10 14:06:06 +08:00
2022-07-29 16:48:58 +08:00
### Docs
2022-01-09 23:25:00 +08:00
2022-04-05 17:35:05 +08:00
[Vue Naive Admin Docs ](https://zclzone.github.io/vue-naive-admin-docs )
2022-04-10 14:06:06 +08:00
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
### Getting Started
2022-01-09 23:25:00 +08:00
```shell
2022-07-29 16:48:58 +08:00
# Recommended setup git autocrlf 为 false
2022-01-09 23:25:00 +08:00
git config --global core.autocrlf false
2022-07-29 16:48:58 +08:00
# Clone Project
2022-01-09 23:25:00 +08:00
git clone https://github.com/zclzone/vue-naive-admin.git
cd vue-naive-admin
2022-07-29 16:48:58 +08:00
# Install dependencies(Recommended use pnpm: https://pnpm.io/zh/installation)
npm i -g pnpm # Installed and can be ignored
pnpm i # or npm i
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
# Start
2022-07-11 12:29:48 +08:00
pnpm dev
2022-01-09 23:25:00 +08:00
```
2022-07-29 16:48:58 +08:00
### Build and Release
2022-01-09 23:25:00 +08:00
```shell
2022-07-29 16:48:58 +08:00
# Test Environment
2022-07-11 12:29:48 +08:00
pnpm build:test
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
# Github Environment
2022-07-11 12:29:48 +08:00
pnpm build:github
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
# Prod Environment
2022-07-11 12:29:48 +08:00
pnpm build
2022-01-09 23:25:00 +08:00
```
2022-07-29 16:48:58 +08:00
### Other
2022-01-09 23:25:00 +08:00
```shell
2022-07-29 16:48:58 +08:00
# eslint check
2022-07-11 12:29:48 +08:00
pnpm lint
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
# eslint check and fix
2022-07-11 12:29:48 +08:00
pnpm lint:fix
2022-01-09 23:25:00 +08:00
2022-07-29 16:48:58 +08:00
# Preview( Need to build first)
2022-07-11 12:29:48 +08:00
pnpm preview
2022-07-29 16:48:58 +08:00
# Commit( husky+commitlint)
2022-07-11 12:29:48 +08:00
pnpm cz
2022-01-09 23:25:00 +08:00
```
2022-03-19 19:13:07 +08:00
2022-08-02 09:31:17 +08:00
### 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 )
2022-08-02 09:34:25 +08:00
#### preview
2022-08-02 09:31:17 +08:00
- [https://admin.qszone.com ](https://admin.qszone.com )
- [https://zclzone.github.io/qs-admin ](https://zclzone.github.io/qs-admin )
2022-04-26 19:59:59 +08:00