Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sankeyangshu/lemon-template-react
使用 React + TS 构建的基础项目模版
https://github.com/sankeyangshu/lemon-template-react
axios i18n-react i18next react react-vant template typescript unocss vant-ui zustand
Last synced: about 1 month ago
JSON representation
使用 React + TS 构建的基础项目模版
- Host: GitHub
- URL: https://github.com/sankeyangshu/lemon-template-react
- Owner: sankeyangshu
- License: mit
- Created: 2023-04-11T12:48:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T15:04:19.000Z (about 1 month ago)
- Last Synced: 2024-12-30T16:18:48.920Z (about 1 month ago)
- Topics: axios, i18n-react, i18next, react, react-vant, template, typescript, unocss, vant-ui, zustand
- Language: TypeScript
- Homepage:
- Size: 949 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
react-template
使用 React + TS 构建的基础项目模版
---
## 简介
🚀🚀🚀 **react-template** 使用了最新的`React18`、`React-Router v6`、`React-Hooks`、`Vite4`、`Zustand`、`Typescript`等主流技术开发，集成 `Dark Mode`(暗黑)模式，并且持久化保存，集成了代码规范检查工具`Eslint`、`Prettier`、`Stylelint`。你可以在此之上直接开发你的业务代码！希望你能喜欢。👋👋👋
**注：如果对您有帮助，您可以点右上角 "Star" 支持一下 谢谢！**
## ✨ 项目功能
- 🚀 采用最新技术栈开发：React18、React-Router v6、React-Hooks、TypeScript、Vite4
- 🚀 采用 Vite4 作为项目开发、打包工具（配置 Gzip 打包、TSX 语法、跨域代理…）
- 🚀 整个项目集成了 TypeScript
- 🚀 使用 Zustand 做状态管理，轻量、简单、易用
- 🚀 使用 Prettier 统一格式化代码，集成 Eslint、Stylelint 代码校验规范（项目规范配置）
- 🚀 使用 husky、lint-staged、commitlint 规范提交信息（项目规范配置）
## 基础知识
提前了解和学习这些知识会对使用本项目有很大的帮助。
- [React](https://react.dev/) - 熟悉 `React` 基础语法
- [React-Router](https://reactrouter.com/en/main) - 熟悉 `React-Router`基本使用
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - 熟悉 `Zustand` 基本使用
- [Vite](https://cn.vitejs.dev/) - 熟悉 `Vite` 特性
- [TypeScript](https://www.typescriptlang.org/) - 熟悉 `TypeScript` 基本语法
- [Icones](https://icones.js.org/) - 本项目推荐图标库，当然你也可以使用其他图标库
- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 `ES6` 基本语法
## 环境准备
本地环境需要安装 [pnpm7.x](https://www.pnpm.cn/)、[Node.js](http://nodejs.org/) 和 [Git](https://git-scm.com/)
- 必须使用[pnpm7.x](https://www.pnpm.cn/)，否则依赖可能安装不上。
- [Node.js](http://nodejs.org/) 版本要求`12.x`以上，这里推荐 `16.x` 及以上。
## Vscode 配套插件
如果你使用的 IDE 是[vscode](https://code.visualstudio.com/)(推荐)的话，可以安装以下工具来提高开发效率及代码格式化
- [ES7+ React/Redux/React-Native snippets](https://marketplace.visualstudio.com/items?itemName=dsznajder.es7-react-js-snippets) - react 开发必备
- [CSS Modules](https://marketplace.visualstudio.com/items?itemName=clinyong.vscode-css-modules) - css 模块化支持
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - 脚本代码检查
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - 代码格式化
- [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - css 格式化
## 安装和使用
### 克隆使用
```bash
# 克隆项目
git clone https://github.com/sankeyangshu/react-template.git
# 进入项目目录
cd react-template
# 安装依赖 - 推荐使用pnpm
pnpm install
# 启动服务
pnpm dev
# 打包发布
pnpm build
```
## 如何贡献
你可以[提一个 issue](https://github.com/sankeyangshu/react-template/issues) 或者提交一个 Pull Request。
**Pull Request:**
1. Fork 代码
2. 创建自己的分支: `git checkout -b feat/xxxx`
3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
4. 推送您的分支: `git push origin feat/xxxx`
5. 提交 `pull request`
## Git 贡献提交规范
- `feat`: 新增功能
- `fix`: 修复 bug
- `docs`: 文档变更
- `style`: 代码格式（不影响功能，例如空格、分号等格式修正）
- `refactor`: 代码重构（不包括 bug 修复、功能新增）
- `perf`: 性能优化
- `test`: 添加、修改测试用例
- `build`: 构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）
- `ci`: 修改 CI 配置、脚本
- `chore`: 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
- `revert`: 回滚 commit
## 浏览器支持
- 本地开发推荐使用 Chrome 最新版浏览器 [Download](https://www.google.com/intl/zh-CN/chrome/)。
- 生产环境支持现代浏览器，不在支持 IE 浏览器，更多浏览器可以查看 [Can I Use Es Module](https://caniuse.com/?search=ESModule)。
| [
](http://godban.github.io/browsers-support-badges/)IE | [
](http://godban.github.io/browsers-support-badges/)Edge | [
](http://godban.github.io/browsers-support-badges/)Firefox | [
](http://godban.github.io/browsers-support-badges/)Chrome | [
](http://godban.github.io/browsers-support-badges/)Safari |
| :----------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
## 许可证
[MIT License](https://github.com/sankeyangshu/react-template/blob/master/LICENSE)