Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdsuwwz/vite-naive-template
🏄♂️ 一个简洁的 NaiveUI + Vite 5 + Vue3 + TSX + Pinia + UnoCSS + Unplugin + ESLint(v9) + Vitest 的 B 端后台 Admin 原型模板框架, 开箱即用, 内置模块化管理、Commit 规范检测 Husky + lint-staged 、路由鉴权、暗黑模式、Unplugin Auto 自动导入, 适合快速搭建和二次开发实际业务场景, 持续更新最新技术栈 🎊
https://github.com/pdsuwwz/vite-naive-template
husky lint-staged naive naiveui pinia starter ui vite vitest vue vue3
Last synced: about 1 month ago
JSON representation
🏄♂️ 一个简洁的 NaiveUI + Vite 5 + Vue3 + TSX + Pinia + UnoCSS + Unplugin + ESLint(v9) + Vitest 的 B 端后台 Admin 原型模板框架, 开箱即用, 内置模块化管理、Commit 规范检测 Husky + lint-staged 、路由鉴权、暗黑模式、Unplugin Auto 自动导入, 适合快速搭建和二次开发实际业务场景, 持续更新最新技术栈 🎊
- Host: GitHub
- URL: https://github.com/pdsuwwz/vite-naive-template
- Owner: pdsuwwz
- License: mit
- Created: 2023-06-12T08:44:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-24T10:04:10.000Z (about 2 months ago)
- Last Synced: 2024-07-24T11:39:29.506Z (about 2 months ago)
- Topics: husky, lint-staged, naive, naiveui, pinia, starter, ui, vite, vitest, vue, vue3
- Language: Vue
- Homepage: https://pdsuwwz.github.io/vite-naive-template/
- Size: 12.1 MB
- Stars: 22
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vite-naive-template
[](https://github.com/pdsuwwz/vite-naive-template/actions/workflows/deploy.yml)
[](https://github.com/pdsuwwz/vite-naive-template/deployments/activity_log?environment=github-pages)
[](https://github.com/pdsuwwz)
[](https://github.com/pdsuwwz/vite-naive-template/blob/main/LICENSE)
[](https://github.com/pdsuwwz/vite-naive-template)
[](https://github.com/pdsuwwz/vite-naive-template)
[](https://github.com/pdsuwwz/vite-naive-template)
🏄♂️ A Starter template built on Vite 5.x + TypeScript + TSX + Vue 3.4 + Naive UI + Pinia + UnoCSS + Unplugin Auto Import + Husky + lint-staged.
一个简洁的 Vite5 + Vue3.4 + TypeScript + TSX + ESLint(v9) 的 B 端后台原型 Naive UI 模板框架，内置 Pinia 模块化管理代码、路由鉴权、UnoCSS 暗黑模式、Unplugin 自动导入等, 开箱即用, 注重快速高效搭建实际业务场景, 持续更新最新技术栈 🎊
[🔥 Live Demo 在线体验](https://pdsuwwz.github.io/vite-naive-template)
> 账号：`[email protected]` (随意邮箱)
>
> 密码：123456 (随意)
## 🪄 使用不同的 UI 库
如果更偏好使用 [Element Plus 2](https://element-plus.org) 作为 UI 库, 这里也为你准备了几个相应的模板项目，可在此基础上进行业务二次开发和定制：
- 🍍 [Pinia + Element Plus + Vue3 + TS 版本](https://github.com/pdsuwwz/vue-boilerplate-i18n)
- ⚡️ [Vuex + Element Plus + Vue3 + TS 版本](https://github.com/pdsuwwz/vite-ts-starter)
## 🎉 Features
* 支持 __Vite 5 + Vue 3.4 + TypeScript + TSX__
* UI 框架: __Naive UI 2.x__
* 状态管理: __Pinia__
* 单元测试框架: __Vitest__
* 代码规范化检测: __Husky + lint-staged__
* 内置 **Unplugin Auto Import**, 支持组件按需自动导入, 解放双手
* 内置 **UnoCSS + Iconify**, 可实现原子化样式内联、图标按需自动导入, 提升开发效率
* 内置 __ESlint__ 和 __Stylelint__, 可在此基础上扩充你想要的 Lint 配置规范
* 内置封装了一个**可能比较好用的** Axios , 需要时配合 Pinia Actions 一起食用
* 封装了 \ 组件, 可直接使用 IconFont 图标
* 简化了 naive-ui 库中[抽屉 drawer](https://www.naiveui.com/zh-CN/os-theme/components/drawer) 的创建过程, 支持全局调用 [window.$ModalDrawer.create](./src/components/Drawer/README.md) 方法管理多个抽屉
* 服务式 service 挂载全局对象 [**window.$ModalXxxx**](https://github.com/pdsuwwz/vite-naive-template/blob/main/src/NaiveProvider.vue#L6-L10) 插件, 更方便的插件调用方式
* 路由鉴权已帮你封装好，同时配合 Nprogress, 只需要修改 [permission.ts](./src/router/permission.ts) 文件即可
* 自带一个模块化的组件开发环境，可按照 modules 目录解耦页面组件、路由组件、样式等文件
* 高度封装但不失灵活，内部抽象出了一个完整的业务流程供你参考，涉及三个核心页面：登录、列表和明细
* 节省你配置的时间，因此该项目的**轻量化**致使你只需要专心编写自己的业务代码即可
## 前置条件
* Vue 3.4+
* Node >= 16.15.x
* Pnpm 8.x
* **VS Code 插件 `dbaeumer.vscode-eslint` >= v3.0.5 (pre-release)**
## 运行效果
## 安装和运行
* 安装依赖
```bash
pnpm i
```
* 本地开发
```bash
pnpm dev
```
## 单元测试
* 执行单测
```bash
pnpm test
```
* 执行覆盖率测试
```bash
pnpm test:coverage
```
## 💡 提示
* 若 Husky 未生效，可能是由于未完成初始化，尝试执行以下命令进行初始化:
```bash
pnpm run prepare
```
## 😎 Awesome
* [awesome-vite](https://github.com/pdsuwwz/awesome-vite)
## License
[MIT](./LICENSE) License | Copyright © 2020-PRESENT [Wisdom](https://github.com/pdsuwwz)