Skip to content

Commit 4ddcf94

Browse files
authored
feat: update README.md (#58)
* feat: update README.md * fix: 删除无用文件
1 parent 8c8ee82 commit 4ddcf94

File tree

3 files changed

+88
-137
lines changed

3 files changed

+88
-137
lines changed

README-EN.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# vue3-management-system
2+
3+
Language: English | [中文简体](README.md)
4+
5+
Based on the background management system developed by Vue3 Family Bucket, [online address is here](https://vue3-management-system.vercel.app/login). It is suitable for students who are self-studying Vue3, and for quick delivery of outsourced projects.
6+
7+
## technology stack
8+
9+
The project uses the technology stack as follows:
10+
11+
- [x] Vue 3: Front-end framework
12+
- [x] TypeScript: Language
13+
- [x] Vite: packaging tool
14+
- [x] Pinia: state management
15+
- [x] Vue Router: route management
16+
- [x] Element Plus: UI component library
17+
- [x] Echarts: Charts
18+
- [x] Axios: network requests
19+
20+
## project screenshot
21+
22+
Login page:
23+
![image](https://user-images.githubusercontent.com/51811652/227832497-7bc46908-d818-48ce-8ecd-bac57c3d9855.png)
24+
25+
home page:
26+
![image](https://user-images.githubusercontent.com/51811652/227833231-3b91552a-618f-41de-bbc1-fc6f68177a7d.png)
27+
28+
table page:
29+
![image](https://user-images.githubusercontent.com/51811652/227835053-4d680143-b165-4bbf-9f04-97c4a5422635.png)
30+
31+
## Project Setup
32+
33+
```
34+
# clone project
35+
git clone https://github.com/HearLing/vue3-management-system.git
36+
37+
# enter the project directory
38+
cd vue3-management-system
39+
40+
# install dependencies
41+
npm install
42+
43+
# Local development, start the service
44+
npm run dev
45+
46+
# package build
47+
npm run build
48+
49+
# ESLint fixes
50+
npm run lint
51+
```

README-ZH.md

Lines changed: 0 additions & 108 deletions
This file was deleted.

README.md

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,59 @@
11
# vue3-management-system
2-
Language: English | [中文简体](README-ZH.md)
32

4-
This template should help get you started developing with Vue 3 in Vite.
3+
文档语言: [English](README-EN.md) | 中文简体
54

6-
## Introduce
5+
基于 Vue3 全家桶开发的后台管理系统,[线上地址在这](https://vue3-management-system.vercel.app/login)。适用于自学 Vue3 的同学,以及外包项目快速交付。
76

8-
The main branch is used to ensure that you can run it first, and then we will create a branch for requirements
7+
## 技术栈
98

10-
## Recommended IDE Setup
9+
该项目使用技术栈如下:
1110

12-
[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).
11+
- [x] Vue 3:前端框架
12+
- [x] TypeScript:语言
13+
- [x] Vite:打包工具
14+
- [x] Pinia:状态管理
15+
- [x] Vue Router:路由管理
16+
- [x] Element Plus:UI 组件库
17+
- [x] Echarts:图表
18+
- [x] Axios:网络请求
1319

14-
## Type Support for `.vue` Imports in TS
20+
## 项目截图
1521

16-
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
22+
登录页:
23+
![image](https://user-images.githubusercontent.com/51811652/227832497-7bc46908-d818-48ce-8ecd-bac57c3d9855.png)
1724

18-
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
25+
首页:
26+
![image](https://user-images.githubusercontent.com/51811652/227833231-3b91552a-618f-41de-bbc1-fc6f68177a7d.png)
1927

20-
1. Disable the built-in TypeScript Extension
21-
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
22-
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
23-
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
28+
表格:
29+
![image](https://user-images.githubusercontent.com/51811652/227835053-4d680143-b165-4bbf-9f04-97c4a5422635.png)
2430

25-
## Customize configuration
31+
## 安装
2632

27-
See [Vite Configuration Reference](https://vitejs.dev/config/).
33+
```
34+
# 克隆项目
35+
git clone https://github.com/HearLing/vue3-management-system.git
2836
29-
## Project Setup
37+
# 进入项目目录
38+
cd vue3-management-system
3039
31-
```sh
40+
# 安装依赖
3241
npm install
33-
```
34-
35-
### Compile and Hot-Reload for Development
3642
37-
```sh
43+
# 本地开发,启动服务
3844
npm run dev
39-
```
40-
41-
### Type-Check, Compile and Minify for Production
4245
43-
```sh
46+
# 打包构建
4447
npm run build
45-
```
46-
47-
### Lint with [ESLint](https://eslint.org/)
4848
49-
```sh
49+
# ESLint修复
5050
npm run lint
5151
```
52+
53+
## 参考资料
54+
55+
- [x] [参考项目](https://preview.pro.ant.design/dashboard/analysis)
56+
- [x] [Vue3 中文文档](https://cn.vuejs.org)
57+
- [x] [Vue Router 中文文档](https://router.vuejs.org/zh/)
58+
- [x] [Pinia 中文文档](https://pinia.vuejs.org/zh/)
59+
- [x] [Element Plus 中文文档](https://element-plus.gitee.io/zh-CN/guide/quickstart.html)

0 commit comments

Comments
 (0)