Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peng-xiao-shuai/vite-vue-admin
🎉🎉使用Vite + Vue3 + Pinia + Vue-router + TypeScript + Element-plus + Mock开发的后台管理系统🎉🎉
https://github.com/peng-xiao-shuai/vite-vue-admin
antv-x6 axios element-plus i18n jsx mackdown mock pinia powerful-table tinymce tsx typescript vite vue-router vue3
Last synced: about 4 hours ago
JSON representation
🎉🎉使用Vite + Vue3 + Pinia + Vue-router + TypeScript + Element-plus + Mock开发的后台管理系统🎉🎉
- Host: GitHub
- URL: https://github.com/peng-xiao-shuai/vite-vue-admin
- Owner: peng-xiao-shuai
- License: mit
- Created: 2021-04-02T09:08:25.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T07:35:02.000Z (6 months ago)
- Last Synced: 2024-04-30T05:31:11.968Z (6 months ago)
- Topics: antv-x6, axios, element-plus, i18n, jsx, mackdown, mock, pinia, powerful-table, tinymce, tsx, typescript, vite, vue-router, vue3
- Language: Vue
- Homepage: https://peng-xiao-shuai.github.io/vite-vue-admin/
- Size: 76.6 MB
- Stars: 171
- Watchers: 4
- Forks: 37
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vite-Vue-Admin
**English** | [简体中文](./README.zh-CN.md)
## Docs and Preview
[Docs link](https://peng-xiao-shuai.github.io/vite-vue-admin-docs/)
[Demo](https://peng-xiao-shuai.github.io/vite-vue-admin/)
## introduce
`Vite-Vue-Admin` Is a front-end management template，It is implemented based on `Vite4.x`,` Vue3.x`, `Vue-router4.x`, `Pinia`, `Element-plus`, `TypeScript`. It uses the latest front-end technology stack, built-in `vue-i18n` internationalization solution, dynamic routing, Secondary development of the table component,`antd-x6`，Refined typical business model, provides a wealth of functional components, it can help you quickly build enterprise-level back-end product prototype. It can also be used as an example to learn mainstream technologies such as Vue3, Vite, Ts, etc.
**major dispositions**
- [Pnpm](https://pnpm.io/)
- [Vite](https://vitejs.dev/)
- [Vue](https://vuejs.org/)
- [Pinia](https://pinia.vuejs.org/)
- [Vue-router](https://router.vuejs.org/)
- [Typescript](https://www.tslang.cn/docs/home.html)
- [Axios.js](http://axios-js.com)
- [Mock.js](http://mockjs.com/)
- [Element-plus](https://element-plus.org/en-US/)
**Built-in element-plus Two development Encapsulation**
- `upload-file` (File Upload，Support specified file format,File size)
- `powerful-table` (Multi-function form component)[Documentation readme](https://peng-xiao-shuai.github.io/vite-vue-admin-docs/zh-CN/component/powerful-table-doc.html)
## Project settings
> **Precautions**
1. The default is to use both the development version and the release version `mock`
If the release version needs to be disabled `mock` Please `main.ts` Uncomment the following code under the file
And find `.env.production` Under the file `VITE_MOCK` Variable to modify its `false`
2. Development version disabled `mock` Please`.env.development` Under the file `VITE_MOCK` Variable to modify its `false`
```js
// main.ts
// if (
// import.meta.env.VITE_MOCK === "true"
// ) {
mockXHR()
// }
```
3. **Image download success can not open** [solution](https://blog.csdn.net/m0_71182944/article/details/127161279)
```js
// node_modules/mockjs/dist/mock.js
if (!this.match) {
// 8364 line added
this.custom.xhr.responseType = this.responseType
this.custom.xhr.send(data)
return
}
```
### Install dependencies,
```bash
pnpm install
```
## package.json command introduce
```bash
pnpm dev # project running
pnpm build # Project forming
pnpm tsc # Check code type
pnpm preview # Project preview
pnpm clean:cache # clear cache
pnpm clean:modules # clear node_modules folder
pnpm lint:lint-staged # Verify the code format at commit time
pnpm prepare # init husky
```
## How to Contribute
Welcome to join us! Ask an `Issue` or submit a `Pull Request`.
Pull Request:
1. Fork code!
2. Create your own branch: `git checkout -b feat/xxxx`
3. Submit your changes: `git commit -am 'feat: add xxxxx'`
4. Push your branch: `git push origin feat/xxxx`
5. submit `pull request`
## Git Contribution submission specification
- reference [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) specification ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
- `feat` Add new features
- `fix` Fix the problem/BUG
- `style` The code style is related and does not affect the running result
- `perf` Optimization/performance improvement
- `refactor` Refactor
- `revert` Undo edit
- `test` Test related
- `docs` Documentation/notes
- `chore` Dependency update/scaffolding configuration modification etc.
- `workflow` Workflow improvements
- `ci` Continuous integration
- `types` Type definition file changes
- `wip` In development
## plan （2021-3-30）
- [x] File Upload
- [x] Tencent map (remove)
- [x] Amap selected points
- [x] Amap electronic fence
- [x] graphic edit (Antd-x6)
- [x] signature
- [x] select icon
- [x] Internationalized multilanguage (i18n)
- [x] tablet menu
- [x] Added log menu to catch interface errors as well `errorHandler`
- [x] Global common configuration (component size, theme color, watermark, etc.)
- [x] `markdown` Editor (support formulas, emoticons, flow charts...)
- [x] Permission Test Menu (Permission instruction)
- [ ] The login password is stored locally using MD5 encryption
- [x] `excel` import and export
- [ ] Print instruction, copy instruction
- [x] Global instruction
**Other functions can be `issues` propose**
## contribute
If you think this project helped you, please help click `Star`