Skip to content

Commit

Permalink
docs: 📝 文档更新
Browse files Browse the repository at this point in the history
  • Loading branch information
yosong-github committed Oct 25, 2024
1 parent 7e7dc1e commit e4e29d7
Show file tree
Hide file tree
Showing 6 changed files with 4,538 additions and 3,722 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,33 @@
# yo-admin

这是一个vue3+ts的后台管理模板
## 简介

## 推荐的IDE设置
yo-vue-admin 是一个基于 Vue 3、TypeScript、Vite、Pinia、Element Plus、Vue Router、Axios、ECharts 等技术栈的前端项目模板,旨在为开发者提供一套高效、易用的开发环境,帮助开发者快速搭建和管理前端项目。

## 推荐的 IDE 设置

[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

## 特性

- 使用 Vue 3 Composition API
- 使用 TypeScript
- 使用 Vite 作为构建工具
- 使用 Pinia 作为状态管理工具
- 使用 Element Plus 作为 UI 框架
- 使用 Vue Router 作为路由管理工具
- 使用 Axios 作为 HTTP 客户端
- 使用 ECharts 作为图表库
- 使用 ESLint 和 Prettier 进行代码检查和格式化
- 使用 Husky 和 Lint-staged 进行 Git 钩子管理

## 预览

![alt text](./public/image.png)
![alt text](./public/image2.png)
![alt text](./public/image3.png)

## 项目
## 安装使用

```sh
pnpm install
Expand Down
2 changes: 0 additions & 2 deletions components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ declare module 'vue' {
ElDropdownItem: (typeof import('element-plus/es'))['ElDropdownItem']
ElDropdownMenu: (typeof import('element-plus/es'))['ElDropdownMenu']
ElFooter: (typeof import('element-plus/es'))['ElFooter']
ElForm: (typeof import('element-plus/es'))['ElForm']
ElFormItem: (typeof import('element-plus/es'))['ElFormItem']
ElHeader: (typeof import('element-plus/es'))['ElHeader']
ElIcon: (typeof import('element-plus/es'))['ElIcon']
ElInput: (typeof import('element-plus/es'))['ElInput']
Expand Down
Loading

0 comments on commit e4e29d7

Please sign in to comment.