mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2025-04-06 03:57:49 +08:00
126 lines
6.9 KiB
Markdown
126 lines
6.9 KiB
Markdown
<div align="center">
|
||
<a href="https://github.com/XiaoDaiGua-Ray/ray-template"> <img alt="Ray Template" width="200" height="200" src="https://r2chevereto.yka.moe/longmao.navigator.th.png"> </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
|
||
|
||
简体中文 | [English](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/README.md)
|
||
|
||
一个 `免费`、`高效`、`特性完整` 并且基于 vite5.x & ts(x) & pinia & vue3.x 等最新技术的中后台模板。
|
||
|
||
</div>
|
||
|
||
## ✨ 特性
|
||
|
||
- **靠爱发电**：几乎包含市面常见的模板特性并且全部免费使用
|
||
- **最新技术栈**：使用 vue3.x/vite5.x/pinia 等前端前沿技术开发
|
||
- **TypeScript**：应用程序级 JavaScript 的语言
|
||
- **主题**：可配置的主题
|
||
- **国际化**：内置完善的国际化方案
|
||
- **Mock 数据**：内置 Mock 数据方案
|
||
- **权限**：内置完善的动态路由权限生成方案
|
||
- **组件**：二次封装了多个常用的组件
|
||
- **Axios 请求**：二次封装 axios 库，支持：取消、防抖、自动重复取消等功能
|
||
- **缓存**：任意深度页面缓存
|
||
- **SVG**：内置 svg icon 解决方案
|
||
- **独立的 Data Methods Views**：解耦管理的数据、方法、视图，放心二次开发
|
||
- **模板专属 hooks**：基于模板特性封装的 hooks 让你更加方便的使用模板一些功能
|
||
|
||
## 🪄 预览地址
|
||
|
||
- [点击预览](https://xiaodaigua-ray.github.io/ray-template/#/)
|
||
- [点击预览(加速地址)](https://ray-template.yunkuangao.com/#/)
|
||
|
||
## 🦾 文档地址
|
||
|
||
- [文档](https://xiaodaigua-ray.github.io/ray-template-doc/)
|
||
- [文档(加速地址)](https://ray-template.yunkuangao.com/ray-template-doc/)
|
||
|
||
## 🔋 更新日志
|
||
|
||
- [更新日志](https://github.com/XiaoDaiGua-Ray/xiaodaigua-ray.github.io/blob/main/CHANGELOG.md)
|
||
|
||
## 🪴 准备
|
||
|
||
- [Node](http://nodejs.org/) 和 [git](https://git-scm.com/) - 项目开发环境
|
||
- [Vite](https://vitejs.dev/) - 熟悉 vite 特性
|
||
- [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法
|
||
- [TypeScript](https://www.typescriptlang.org/) - 熟悉 TypeScript 基本语法
|
||
- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法
|
||
- [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router4.x 基本使用
|
||
- [Naive-UI](https://www.naiveui.com) - ui 基本使用
|
||
- [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法
|
||
- [Pinia](https://pinia.vuejs.org/zh/introduction.html) - 状态管理器 pinia 使用
|
||
- [TSX](https://github.com/vuejs/babel-plugin-jsx/blob/main/packages/babel-plugin-jsx/README-zh_CN.md) - tsx 基本语法
|
||
|
||
## 📦 起步
|
||
|
||
### 获取项目
|
||
|
||
```sh
|
||
# github
|
||
git clone https://github.com/XiaoDaiGua-Ray/ray-template.git
|
||
|
||
# 如果你的下载速度很慢，可以切换到下面的代理地址
|
||
git clone https://gh.yka.moe/https://github.com/XiaoDaiGua-Ray/ray-template.git
|
||
```
|
||
|
||
### 拉取依赖
|
||
|
||
```sh
|
||
pnpm i
|
||
```
|
||
|
||
### 启动项目
|
||
|
||
```sh
|
||
pnpm dev
|
||
```
|
||
|
||
### 项目打包
|
||
|
||
```sh
|
||
pnpm build
|
||
```
|
||
|
||
### 预览项目
|
||
|
||
```sh
|
||
pnpm preview
|
||
```
|
||
|
||
### 体积分析
|
||
|
||
```sh
|
||
pnpm report
|
||
```
|
||
|
||
### 开发
|
||
|
||
简介、易上手是该模板的核心思路。所以你可以放心的直接删除 `views/demo` `router/moduels/demo` 下的所有文件，这样就是一个干净的项目了。
|
||
|
||
## 🪴 项目活动
|
||
|
||
|
||
|
||
### 贡献者
|
||
|
||
感谢他们的所做的一切贡献 🐝 ！
|
||
|
||
<a href="https://github.com/XiaoDaiGua-Ray/ray-template/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=XiaoDaiGua-Ray/ray-template" />
|
||
</a>
|
||
|
||
## 浏览器支持
|
||
|
||
| [<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 |
|
||
|
||
## 📄 证书
|
||
|
||
[MIT License](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/LICENSE) © 2022-PRESENT [Ray](https://github.com/XiaoDaiGua-Ray)
|