Skip to content

Latest commit

 

History

History
113 lines (79 loc) · 3.65 KB

README.zh-CN.md

File metadata and controls

113 lines (79 loc) · 3.65 KB

Vue Naive Admin Logo

简体中文 | English

由于作者精力有限,ts版本不再维护,推荐使用js版本。

js 版本: https://github.com/zclzone/vue-naive-admin

简介

Qs Admin 是一个 完全开源免费且允许商用 的后台管理模板,基于 Vue3、Vite3、TypeScript、Pinia、Unocss 和 Naive UI 等前端最新技术栈。相较于其他比较流行的后台管理模板,此项目更加简洁、轻量,风格清新,学习成本非常低,非常适合中小型项目或者个人项目。

功能

  • 🍒 集成 Naive UI
  • 🍑 集成登陆、注销及权限验证
  • 🍐 集成多环境配置,dev、测试、生产和github pages环境
  • 🍎 集成 eslint + prettier,代码约束和格式化统一
  • 🍌 集成 husky + commitlint,代码提交规范化
  • 🍉 集成 mock 接口服务,dev 环境和发布环境都支持,可动态配置是否启用 mock 服务,不启用时不会加载 mock 包,减少打包体积
  • 🍍 集成 pinia,vuex 的替代方案,轻量、简单、易用
  • 📦 集成 unplugin 插件,自动导入,解放双手,开发效率直接起飞
  • 🤹 集成 iconify 图标,支持自定义 svg 图标, 优雅使用icon
  • 🍇 集成 unocss,antfu 开源的原子 css 解决方案,非常轻量

预览

https://admin.isme.top

https://zclzone.github.io/qs-admin

快速开始

# 推荐配置git autocrlf 为 false(本项目规范使用lf换行符,此配置是为防止git自动将源文件转换为crlf)
# 不清楚为什么要这样做的请参考这篇文章:https://www.freesion.com/article/4532642129
git config --global core.autocrlf false

# 克隆项目
git clone https://github.com/zclzone/qs-admin.git

# 进入项目目录
cd qs-admin

# 安装依赖(建议使用pnpm: https://pnpm.io/zh/installation)
npm i -g pnpm # 装了可忽略
pnpm i # 或者 npm i

# 启动
pnpm dev

构建发布

# 构建测试环境
pnpm build:test

# 构建github pages环境
pnpm build:github

# 构建生产环境
pnpm build

其他指令

# eslint代码格式检查
pnpm lint

# 代码检查并修复
pnpm lint:fix

# 预览发布包效果(需先执行构建指令)
pnpm preview

# 提交代码(husky+commitlint)
pnpm cz

JS 版本: Vue Naive Admin

源码

预览

入群交流 & 关于作者