readme: update README.md and add english README.md

2025-04-05 19:42:07 +08:00 · 2023-09-25 16:13:28 +08:00 · 2023-09-25 16:13:28 +08:00 · 353bc7d809
commit 353bc7d809
parent 5e0c85c7f5
2 changed files with 129 additions and 1 deletions
--- a/README-US.md
+++ b/README-US.md
@ -0,0 +1,121 @@
+<div align="center">
+ <a href="https://github.com/XiaoDaiGua-Ray/ray-template"> <img alt="Ray Template" width="200" height="200" src="https://usc1.contabostorage.com/c2e495d7890844d392e8ec0c6e5d77eb:alist/ray/ray.svg?sign=ZklU9Bh5b6oKp1X0LOhGwkx4g5mW4wk_w9Jt5zlZ5EQ=:0"> </a> <br> <br>
+ <a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/LICENSE"><img src="https://img.shields.io/github/license/XiaoDaiGua-Ray/ray-template" alt="LICENSE"></a>
+</div>
+
+<div align="center">
+
+# Ray Template
+
+A middle and backend template based on vite4.x & ts(x) & pinia & vue3.x
+
+</div>
+
+## ✨ Feature
+
+- **Latest Technology Stack**：Developed using front-end cutting-edge technologies such as vue3.x/vite4.x/pinia
+- **TypeScript**：The language for application-level JavaScript
+- **App Theme**：Configurable themes
+- **Globalization**：Built-in complete internationalization solution
+- **Mock Data**：Built-in Mock data scheme
+- **Permissions**：Built-in complete dynamic routing permission generation solution
+- **Components**：Secondary encapsulation of multiple commonly used components
+- **Axios Request**：Secondary encapsulation of the axios library, supporting functions such as cancellation, anti-shake, automatic repeat cancellation, etc.
+- **Page Cache**：Arbitrarily deep page cache
+- **SVG**：Built-in svg icon solution
+- **Standalone Data Methods Views**：Decoupled management of data, methods, and views allows for secondary development with confidence
+
+## 🪄 Preview
+
+- [Click to preview](https://xiaodaigua-ray.github.io/ray-template/#/)
+- [Click to preview(Acceleration address)](https://ray-template.yunkuangao.com/#/)
+
+## 🦾 Document
+
+- [Document](https://xiaodaigua-ray.github.io/ray-template-doc/)
+- [Document(Acceleration address)](https://ray-template.yunkuangao.com/ray-template-doc/)
+
+## 🔋 Change Log
+
+- [Change Log](https://github.com/XiaoDaiGua-Ray/xiaodaigua-ray.github.io/blob/main/CHANGELOG.md)
+
+## 🪴 Prepare
+
+- [Node](http://nodejs.org/) and [git](https://git-scm.com/) - Project development environment
+- [Vite](https://vitejs.dev/) - Familiar with vite features
+- [Vue3](https://v3.vuejs.org/) - Familiar with Vue3.x basic syntax
+- [TypeScript](https://www.typescriptlang.org/) - Familiar with TypeScript basic syntax
+- [Es6+](http://es6.ruanyifeng.com/) - Familiar with es6 basic syntax
+- [Vue-Router-Next](https://next.router.vuejs.org/) - Familiar with the basic use of vue-router4.x
+- [Naive-UI](https://www.naiveui.com) - UI basic usage
+- [Mock.js](https://github.com/nuysoft/Mock) - Mockjs basic syntax
+- [Pinia](https://pinia.vuejs.org/zh/introduction.html) - State manager pinia uses
+- [TSX](https://github.com/vuejs/babel-plugin-jsx/blob/main/packages/babel-plugin-jsx/README-zh_CN.md) - TSX basic syntax
+
+## 📦 Setup
+
+### Get Project
+
+```sh
+# github
+git clone https://github.com/XiaoDaiGua-Ray/ray-template.git
+
+# If your download speed is very slow, you can switch to the proxy address below
+git clone https://gh.yka.moe/https://github.com/XiaoDaiGua-Ray/ray-template.git
+```
+
+### Pull dependencies
+
+```sh
+pnpm i
+```
+
+### Startup project
+
+```sh
+pnpm dev
+```
+
+### Project packaging
+
+```sh
+pnpm build
+```
+
+### Preview project
+
+```sh
+pnpm preview
+```
+
+### Volumetric analysis
+
+```sh
+pnpm report
+```
+
+### Develop
+
+Introduction and ease of use are the core ideas of this template. So you can safely delete all files under `views/demo` and `router/moduels/demo`, and you will have a clean project.
+
+## 🪴 Project Activities
+
+![Alt](https://repobeats.axiom.co/api/embed/fab6071297ab281913a42f07a2779b488cfd62b8.svg 'Repobeats analytics image')
+
+### Contributor
+
+Thanks for all their contributions 🐝!
+
+<a href="https://github.com/XiaoDaiGua-Ray/ray-template/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=XiaoDaiGua-Ray/ray-template" />
+</a>
+
+## Browser Support
+
+| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
+| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+|                                                                                             not support                                                                                              |                                                                                            last 2 versions                                                                                             |                                                                                                  last 2 versions                                                                                                  |                                                                                                last 2 versions                                                                                                |                                                                                                last 2 versions                                                                                                |
+
+## 📄 License
+
+[MIT License](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/LICENSE) © 2022-PRESENT [Ray](https://github.com/XiaoDaiGua-Ray)
--- a/README.md
+++ b/README.md
@ -7,6 +7,8 @@

 # Ray Template

+简体中文 | [English](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/README-US.md)
+
 一个基于 vite4.x & ts(x) & pinia & vue3.x 的中后台模板

 </div>
@ -23,6 +25,7 @@
 - **Axios 请求**：二次封装 axios 库，支持：取消、防抖、自动重复取消等功能
 - **缓存**：任意深度页面缓存
 - **SVG**：内置 svg icon 解决方案
+- **独立的 Data Methods Views**：解耦管理的数据、方法、视图，放心二次开发

 ## 🪄 预览地址

@ -66,7 +69,7 @@ git clone https://gh.yka.moe/https://github.com/XiaoDaiGua-Ray/ray-template.git
 ### 拉取依赖

 ```sh
-pnpm
+pnpm i
 ```

 ### 启动项目
@ -93,6 +96,10 @@ pnpm preview
 pnpm report
 ```

+### 开发
+
+简介、易上手是该模板的核心思路。所以你可以放心的直接删除 `views/demo` `router/moduels/demo` 下的所有文件，这样就是一个干净的项目了。
+
 ## 🪴 项目活动

 ![Alt](https://repobeats.axiom.co/api/embed/fab6071297ab281913a42f07a2779b488cfd62b8.svg 'Repobeats analytics image')