# vue-paobai-admin

**Repository Path**: zheng_yc/vue-paobai-admin

## Basic Information

- **Project Name**: vue-paobai-admin
- **Description**: paobai前端开发框架。基于Vue3、Vite、Arco Design、Pinia、TypeScript等最新技术栈开发。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://paobai.github.io/vue-paobai-admin
- **GVP Project**: No

## Statistics

- **Stars**: 13
- **Forks**: 2
- **Created**: 2021-09-30
- **Last Updated**: 2024-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Vue, vue3, Arco-Design, TypeScript

## README

## 简介

PAOBAI 是一个免费开源的中后台模版。使用了最新的`vue3`,`vite2`,`TypeScript`, `pinia`等主流技术开发，开箱即用的中后台前端解决方案，也可用于学习参考。


## 特性

- **最新技术栈**：Vue 全家桶，基于`Vue3`, `Vite`, `Vue Router` 开发
- **TypeScript**: 应用程序级 JavaScript 的语言
- **UI**：UI库来自字节跳动开源的`Arco Design`
- **Mock 数据**： 内置 Mock 数据方案 搭配`mockjs`,`vite-plugin-mock`插件食用
- **主题**：可配置的主题
- **布局**：内置多种布局方式，满足多方需求
- **权限** 内置完善的根据API动态路由权限生成方案
- **组件** 二次封装了多个常用的组件

## 预览

- [PAOBAI-github-pages](https://paobai.github.io/vue-paobai-admin) - github pages 站点（推荐-速度快）
- [PAOBAI-gitee-pages](https://zheng_yc.gitee.io/vue-paobai-admin) - gitee pages 站点

[comment]: <> (- [PAOBAI]&#40;https://arco.paobai.club&#41; - 自建站点&#40;带宽小&#41;)

测试账号: paobai/paobai

## 准备

- [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境
- [Vite](https://vitejs.dev/) - 熟悉 vite 特性
- [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法
- [TypeScript](https://www.typescriptlang.org/) - 熟悉`TypeScript`基本语法
- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法
- [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用
- [Arco-Design-Vue](https://arco.design/vue/docs/start) - ui 基本使用
- [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法


## 安装使用

- 获取项目代码

```bash
git clone git@github.com:paobai/vue-paobai-admin.git
```

- 安装依赖

```bash
cd vue-paobai-admin

npm install
```

- 运行

```bash
npm run dev
```

- 打包

```bash
npm run build
```

## 项目地址

- [PAOBAI](https://gitee.com/zheng_yc/vue-paobai-admin) gitee
- [PAOBAI](https://github.com/paobai/vue-paobai-admin) github

## 如何贡献

非常欢迎你的加入！[提一个 Issue](https://github.com/paobai/vue-paobai-admin/issues) 或者提交一个 Pull Request。

**Pull Request:**

1. Fork 代码!
2. 创建自己的分支: `git checkout -b feat/xxxx`
3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
4. 推送您的分支: `git push origin feat/xxxx`
5. 提交`pull request`

## Git 贡献提交规范

- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))

    - `feat` 增加新功能
    - `fix` 修复问题/BUG
    - `style` 代码风格相关无影响运行结果的
    - `perf` 优化/性能提升
    - `refactor` 重构
    - `revert` 撤销修改
    - `test` 测试相关
    - `docs` 文档/注释
    - `chore` 依赖更新/脚手架配置修改等
    - `workflow` 工作流改进
    - `ci` 持续集成
    - `types` 类型定义文件更改
    - `wip` 开发中

## 浏览器支持

本地开发推荐使用`Chrome 80+` 浏览器

## 相关仓库
- [vue-vben-admin](https://github.com/anncwb/vue-vben-admin) - vben
- [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import) - 用于组件库样式按需引入
- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - 用于本地及开发环境数据 mock

## 维护者

[@Zheng_yc-gitee](https://gitee.com/zheng_yc)
[@Zheng_yc-github](https://github.com/paobai)

## 交流

`PAOBAI` 是完全开源免费的项目，在帮助开发者更方便地进行中大型管理系统开发，同时也提供 QQ 交流群使用问题欢迎在群内提问。

- QQ 群 `暂无`

## License

[MIT © PAOBAI-2022](./LICENSE)