-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: adjust the language of the main document to Chinese
- Loading branch information
Showing
3 changed files
with
196 additions
and
196 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| <div align="center"> | ||
| <a href="https://github.com/crlang/vue-tony-admin"> <img alt="Tony Admin Logo" width="200" height="200" src="http://tony.crlang.com/images/logo.png"></a> | ||
| <br> | ||
| <br> | ||
| <br> | ||
| <h1>Vue Tony Admin</h1> | ||
| </div> | ||
|
|
||
| **English** | [中文](./README.zh-CN.md) | ||
|
|
||
| ## Introduction | ||
|
|
||
| Vue Tony Admin is a free and open source management side frontend template. Based on `Element Plus`, and using the latest `vue3`, `vite2`, `TypeScript` and more mainstream technologies, it is an out-of-the-box management side frontend solution. | ||
|
|
||
| ## Feature | ||
|
|
||
| - **🎉 The latest technology stack**: Develop with front-end cutting-edge technologies such as Vue3/vite2/TypeScript | ||
| - **🧪 Rich Scenes**: up to 60+ rich real scene examples | ||
| - **🎨 Variable Themes**: Configurable themes | ||
| - **👓 Dark Mode**: One step ahead of dark mode support | ||
| - **🌐 Internationalization**: Built-in perfect internationalization solution | ||
| - **🧩 Mock Data** Built-in mock data scheme | ||
| - **🔒 Permission Control** Built-in perfect dynamic routing permission generation scheme | ||
| - **🎫 Easy-to-use components** Encapsulation 30+ common and easy-to-use components | ||
|
|
||
| ## Preview | ||
|
|
||
| - [Github](https://crlang.github.io/vue-tony-admin-site) | ||
| - [Tony](https://tony.crlang.com/vue-tony-admin-site) | ||
|
|
||
| ## Documentation | ||
|
|
||
| [Document](http://tony.crlang.com/doc/) | ||
|
|
||
| ## Preparation | ||
|
|
||
| - [Tony](http://tony.crlang.com/doc/) - Tony Admin document | ||
| - [Vue3](https://v3.cn.vuejs.org/) - Vue3 document | ||
| - [Element-Plus](https://element-plus.gitee.io/) - Element Plus document | ||
| - [TypeScript](https://www.tslang.cn/docs/home.html) - TypeScript document | ||
| - [Vite](https://cn.vitejs.dev/) - Vite2 configure | ||
| - [Mock.js](http://mockjs.com/examples.html) - mockjs Example | ||
|
|
||
| ## Install and use | ||
|
|
||
| - | ||
|
|
||
| ```bash | ||
|
|
||
| # clone the project code | ||
| git clone https://github.com/crlang/vue-tony-admin.git | ||
|
|
||
| # switch folder | ||
| cd vue-tony-admin | ||
|
|
||
| # installation dependencies | ||
| yarn install | ||
|
|
||
| # run | ||
| yarn dev | ||
|
|
||
| # build | ||
| yarn build | ||
|
|
||
| ``` | ||
|
|
||
| ## Change Log | ||
|
|
||
| [CHANGELOG](./CHANGELOG.en_US.md) | ||
|
|
||
| ## Project | ||
|
|
||
| - [vue-tony-admin](https://github.com/crlang/vue-tony-admin) | ||
|
|
||
| ## How to contribute | ||
|
|
||
| You are very welcome to join！[Raise an issue](https://github.com/crlang/vue-tony-admin/issues/new/choose) 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(function): 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) | ||
|
|
||
| - `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 | ||
|
|
||
| ## Browser support | ||
|
|
||
| The `Chrome 80+` browser is recommended for local development | ||
|
|
||
| Support modern browsers, not IE | ||
|
|
||
| | IE | Edge | Firefox | Chrome | Safari | | ||
| | :---------: | :-------------: | :-------------: | :-------------: | :-------------: | | ||
| | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | | ||
|
|
||
| ## Maintainer | ||
|
|
||
| [@CRLang](https://github.com/crlang) | ||
|
|
||
| ## Donate | ||
|
|
||
| If you think this project is helpful to you, you can help the author buy a cup of coffee to show your support! | ||
|
|
||
| <img alt="Tony Admin donate" width="400" height="200" src="https://crlang.com/sponsor2.png"> | ||
|
|
||
| -- <a href="https://www.paypal.com/paypalme/crlang123">Paypal Me</a> -- | ||
|
|
||
| ## grateful | ||
|
|
||
| Thanks to Vue, Antd, Vben, Element Plus for open source support | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](./LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.