# fast-adming

**Repository Path**: hzcsleep/fast-adming

## Basic Information

- **Project Name**: fast-adming
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-27
- **Last Updated**: 2025-12-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Fast Admin

## 项目介绍

Fast Admin 是一个基于 Vue 3 + TypeScript + Vite 构建的系统模板。该项目采用最新的前端技术栈，已经对eslint、prettier、cz-git、commitlint、commitizen、husky、lint-staged等工具进行了集成,提供了一套完整的开发流程和规范（该项目集成了谷歌规范，如对代码质量要求更高的，可额外再安装sonarlint插件对代码检查）。另外，该项目还集成了 Pinia、Vue Router、Element Plus 等常用的前端库和工具，方便开发者快速构建和开发系统。

## 技术栈

- 核心框架：Vue 3
- 开发语言：TypeScript
- 构建工具：Vite
- 代码规范：ESLint + Prettier
- 样式预处理：CSS/SCSS
- 状态管理：Pinia
- 路由管理：Vue Router
- UI框架_: Element Plus
- hooks库: VueUse
- 代码检查工具: eslint
- 代码格式化工具: prettier
- 代码提交工具: cz-git
- 代码提交规范: commitlint
- 代码提交规范工具: husky + lint-staged + commitizen



## 项目特性

- 🚀 采用 Vue 3 + TypeScript 开发，支持 TSX
- 📦 基于 Vite 构建，开发体验极致
- 🎯 代码规范化，统一编码风格

## 快速开始

### 环境准备

- Node.js >= 18.20.6

### 安装依赖

```bash
yarn 
```
### 开发环境运行
```bash
yarn dev
 ```

### 生产环境构建
```bash
yarn build
 ```

 ### 代码提交(建议使用cz-git提交)
```bash
git add .
npm run cz
//详细规范请参考commitlint.config.cjs
//如需跳过检查请使用git commit -m "<提交消息>" -n # Skips Git hooks
 ```

## 项目结构
```plaintext
├── public/               # 静态资源
├── src/                  # 源代码
│   ├── assets/          # 静态资源
│   ├── components/      # 公共组件
│   ├── hooks/           # Vue Hooks
│   ├── pages/           # 页面组件
│   ├── router/          # 路由配置
│   ├── store/           # 状态管理
│   ├── utils/           # 工具函数
│   ├── App.vue          # 根组件
│   └── main.ts          # 入口文件
├── .env                 # 环境变量
└── package.json         # 项目配置
 ```

## 开发规范
- 遵循 ESLint 规范
- 使用 Prettier 进行代码格式化
- 提交代码前进行 Husky 检查


## 文档资料
- Vue 3 官方文档：https://cn.vuejs.org/
- TypeScript 官方文档：https://www.tslang.cn/
- Vite 官方文档：https://vitejs.cn/vite3-cn/guide/
- Element Plus 官方文档：https://element-plus.org/zh-CN/
- eslint 官方文档：https://eslint.nodejs.cn/docs/latest/
- prettier 官方文档：https://www.prettier.cn/
- husky 官方文档：https://husky.nodejs.cn/get-started.html
- cz-git 官方文档：https://cz-git.qbb.sh/zh/
- commitlint 官方文档：https://commitlint.js.org/
- lint-staged 官方文档：https://www.npmjs.com/package/lint-staged
- vueuse 官方文档：https://vueuse.nodejs.cn/guide/



## 贡献指南
1. Fork 本仓库
2. 创建新的功能分支 ( git checkout -b feature/xxx )
3. 提交你的更改 ( git commit -m 'feat: add xxx' )
4. 推送到远程分支 ( git push origin feature/xxx )
5. 提交 Pull Request


## 许可证
MIT

```plaintext

这个 README 文档包含了以下主要内容：
1. 项目简介和技术栈说明
2. 项目特性列表
3. 快速开始指南
4. 项目结构说明
5. 开发规范
6. 贡献指南
7. 许可证信息

你可以根据实际项目需求对内容进行调整和补充。
 ```