mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2025-04-05 19:42:07 +08:00
199 lines
8.0 KiB
Markdown
199 lines
8.0 KiB
Markdown
<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>
|
|
|
|
<h1>Ray Template</h1>
|
|
</div>
|
|
|
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
|
|
[](#contributors-)
|
|
|
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
|
|
## 前言
|
|
|
|
> 该项目模板采用 `vue3.x` `vite4.x` `pinia` `tsx` 进行开发。
|
|
> 使用 `naive ui` 作为组件库。
|
|
> 预设了最佳构建体验的配置与常用搬砖工具。意在提供一个简洁、快速上手的模板。
|
|
> 该模板不支持移动端设备。
|
|
|
|
## 感谢
|
|
|
|
> 感谢 [`yun`](https://me.yka.moe/) 对于本人的支持。
|
|
|
|
## 预览地址
|
|
|
|
- [点击预览](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)
|
|
|
|
## 常见问题
|
|
|
|
- [常见问题](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/COMMONPROBLEM.md)
|
|
|
|
## 特性
|
|
|
|
- **最新技术栈**：使用 Vue3.x/vite4.x 等前端前沿技术开发
|
|
- **TypeScript**：应用程序级 JavaScript 的语言
|
|
- **主题**：可配置的主题
|
|
- **国际化**：内置完善的国际化方案
|
|
- **Mock 数据**：内置 Mock 数据方案
|
|
- **权限**：内置完善的动态路由权限生成方案
|
|
- **组件**：二次封装了多个常用的组件
|
|
- **Axios 请求**：二次封装 axios 库
|
|
|
|
## 准备
|
|
|
|
- [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 基本语法
|
|
|
|
## 未来
|
|
|
|
> 根据个人时间空余情况，会不定时对该模板进行更新和迭代。希望将该工具的功能不断补全（虽然现在已经是足够日常开发和使用），将该模板打造为一个更加健全的中后台模板。如果你有好的想法和建议，可以直接联系我或者直接提 `issues` 即可。
|
|
|
|
## 提示
|
|
|
|
> 项目默认启用严格模式 `eslint`，但是由于 `vite-plugin-eslint` 插件优先级最高，所以如果出现自动导入类型错误提示，请优先解决其他问题。
|
|
> 建议开启 `vscode` 保存自动修复功能。
|
|
|
|
## 项目安装
|
|
|
|
```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
|
|
# yarn
|
|
|
|
yarn
|
|
```
|
|
|
|
```sh
|
|
# npm
|
|
|
|
npm install
|
|
```
|
|
|
|
## 启动项目
|
|
|
|
```sh
|
|
# yarn
|
|
|
|
yarn dev
|
|
```
|
|
|
|
```sh
|
|
# npm
|
|
|
|
npm run dev
|
|
```
|
|
|
|
## 项目打包
|
|
|
|
```sh
|
|
# yarn
|
|
|
|
yarn build
|
|
```
|
|
|
|
```sh
|
|
# npm
|
|
|
|
npm run build
|
|
```
|
|
|
|
## 预览项目
|
|
|
|
```sh
|
|
# yarn
|
|
|
|
yarn preview
|
|
```
|
|
|
|
```sh
|
|
# npm
|
|
|
|
npm run preview
|
|
```
|
|
|
|
## 体积分析
|
|
|
|
```sh
|
|
# yarn
|
|
|
|
yarn report
|
|
```
|
|
|
|
```sh
|
|
# npm
|
|
|
|
npm run report
|
|
```
|
|
|
|
## 浏览器支持
|
|
|
|
> 仅支持现代浏览器，不支持 `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>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 |
|
|
|
|
## 最后，希望大家搬砖愉快
|
|
|
|
## 贡献者
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://heartofyun.com"><img src="https://avatars.githubusercontent.com/u/40163747?v=4?s=100" width="100px;" alt="Cloud"/><br /><sub><b>Cloud</b></sub></a><br /><a href="#tool-yunkuangao" title="Tools">🔧</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
|
## Contributors ✨
|
|
|
|
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
|
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
|
|
|
## License
|
|
|
|
[MIT © Ray-2020](./LICENSE)
|