mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2025-04-05 07:03:00 +08:00
155 lines
7.9 KiB
Markdown
155 lines
7.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://avatars.githubusercontent.com/u/51957438?v=4"
|
|
/>
|
|
</a>
|
|
<br />
|
|
<br />
|
|
<a href="https://nodejs.org/en/about/previous-releases"><img src="https://img.shields.io/node/v/vite.svg" alt="node compatibility"></a>
|
|
<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>
|
|
<a href="#badge"><img src="https://img.shields.io/github/languages/top/XiaoDaiGua-Ray/ray-template" alt="language"></a>
|
|
<a href="https://www.npmjs.com/package/ray-template"><img src="https://img.shields.io/npm/v/ray-template" alt="npm package"></a>
|
|
</div>
|
|
|
|
<div align="center">
|
|
|
|
# Ray Template
|
|
|
|
English | [简体中文](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/README.zh-CN.md)
|
|
|
|
A `completely free`, `efficient`, `feature complete` and based on vite5. x & ts(x) & pinia & vue3. x and other latest technology in the background template.
|
|
|
|
</div>
|
|
|
|
## 🌻 Intro
|
|
|
|
`Ray Template` uses cutting-edge front-end technology, abandoning complexity and bloat, using modular design, decoupling data, methods and views, focusing on business development. Provide rich configuration and rich template `Hooks`, support personalized customization, to meet your project needs.
|
|
|
|
## ✨ Features
|
|
|
|
- `New technology stack:` using ts(x), vite5. x, vue3. x, pinia and other front-end cutting-edge technology development
|
|
- `Theme:` configurable theme
|
|
- `Internationalization:` built-in perfect internationalization solution
|
|
- `Permissions:` built-in perfect dynamic routing permission generation solution
|
|
- `Components:` secondary encapsulation of multiple common components
|
|
- `Toolkit:` common tool function packaging
|
|
- `Cache:` arbitrary depth page caching
|
|
- `Modular design:` decoupling management data, methods, views, rest assured secondary development
|
|
- `Configurable:` support rich configuration items
|
|
- `Code style:` built-in prettier, eslint and other code style tools
|
|
- `Multi-terminal adaptation:` support pc, phone, pad
|
|
- `Documentation:` complete documentation
|
|
- `Mock data:` built-in Mock data solution
|
|
- `Axios request:` the plug-in design is used to encapsulate the axios library interceptor twice, which makes the interceptor more flexible
|
|
- `SVG:` built-in svg icon solution
|
|
- `Hooks:` based on the template characteristics of the encapsulated hooks to make it easier to use some functions of the template
|
|
- `TypeScript:` provide a complete type
|
|
- `Vitest:` built-in vitest test solution
|
|
|
|
## 👀 Preview
|
|
|
|
- [Preview](https://xiaodaigua-ray.github.io/ray-template/#/)
|
|
|
|
## 📌 Documentation
|
|
|
|
- [Documentation](https://xiaodaigua-ray.github.io/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 Vue basic syntax
|
|
- [TypeScript](https://www.typescriptlang.org/) - familiar with TypeScript basic syntax
|
|
- [ES6+](http://es6.ruanyifeng.com/) - familiar with es6 basic syntax
|
|
- [Vue-Hooks-Plus](https://inhiblabcore.github.io/docs/hooks/) - familiar with vue-hooks-plus useRequest method basic use
|
|
- [Vue-Router-Next](https://next.router.vuejs.org/) - familiar with vue-router4.x basic use
|
|
- [Naive-UI](https://www.naiveui.com) - naive ui basic use
|
|
- [Mock.js](https://github.com/nuysoft/Mock) - mockjs basic syntax
|
|
- [Pinia](https://pinia.vuejs.org/zh/introduction.html) - state manager pinia usage
|
|
- [TSX](https://github.com/vuejs/babel-plugin-jsx/blob/main/packages/babel-plugin-jsx/README-zh_CN.md) - tsx basic syntax
|
|
- [Vitest](https://cn.vitest.dev/guide/) - vitest basic use
|
|
|
|
## 📦 Setup
|
|
|
|
### Get Project
|
|
|
|
```sh
|
|
# github
|
|
git clone https://github.com/XiaoDaiGua-Ray/ray-template.git
|
|
```
|
|
|
|
### Pull dependencies
|
|
|
|
```sh
|
|
pnpm i
|
|
```
|
|
|
|
### Test project
|
|
|
|
```sh
|
|
|
|
pnpm test
|
|
```
|
|
|
|
### Startup project
|
|
|
|
```sh
|
|
pnpm dev
|
|
```
|
|
|
|
### Build project
|
|
|
|
```sh
|
|
pnpm build
|
|
```
|
|
|
|
### Preview project
|
|
|
|
```sh
|
|
pnpm preview
|
|
```
|
|
|
|
### Report project
|
|
|
|
```sh
|
|
pnpm report
|
|
```
|
|
|
|
### Development
|
|
|
|
Just delete the files under `views/demo`, `router/modules/demo` to get a clean project template.
|
|
|
|
## 🪴 Project Activities
|
|
|
|
|
|
|
|
### Contributors
|
|
|
|
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)
|