README.CN.md
July 20, 2025 · View on GitHub
中文 | English
简介
基于React18,And Design,Vite4等主流技术开发的开箱即用后台模板,内置国际化、路由权限控制等方案能够满足多数企业管理系统需求!
特性
- 最新技术栈:使用 React18/Vite4 等前端前沿技术开发
- 主题:可配置的主题
- 国际化:内置完善的国际化方案
- 权限:权限路由
预览
准备
- Node 和 Git -项目开发环境
- Vite - 熟悉 Vite 特性
- React18 - 熟悉 React18 基础语法
- Es6+ - 熟悉 Es6 基本语法
- React Router V6 - 熟悉 React Router V6 基本使用
- And Design 5 - Ui 基本使用
- Emotion - 基本使用
安装使用
1. 获取项目代码(Https or SSH)
git clone https://github.com/jsxiaosi/react-xs-admin.git
git clone git@github.com:jsxiaosi/react-xs-admin.git
或者通过xs-cli快速创建
npx @jsxiaosi/xs-cli create [project-name]
2.安装依赖
cd react-xs-admin
推荐使用pnpm
pnpm i
npm安装
npm install
# 建议不要直接使用 cnpm 安装以来,会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
# 如果下载依赖慢可以使用淘宝镜像源安装依赖
npm install --registry=https://registry.npm.taobao.org
3.运行
npm run dev
4.打包
npm run build
项目地址
如何贡献
Pull Request:
- Fork 代码!
- 创建自己的分支:
git checkout -b feature/xxxx - 提交你的修改:
git commit -m 'feature: add xxxxx' - 推送您的分支:
git push origin feature/xxxx - 提交
pull request
Git 贡献提交规范
- 参考 vue 规范
feat新增功能fix修复缺陷docs文档变更style代码格式refactor代码重构perf性能优化test添加疏漏测试或已有测试改动build构建流程、外部依赖变更 (如升级 npm 包、修改打包配置等)ci修改 CI 配置、脚本revert回滚 commitchore对构建过程或辅助工具和库的更改 (不影响源文件)wip正在开发中types类型定义文件修改
浏览器支持
本地开发推荐使用Chrome 80+ 浏览器
支持现代浏览器, 不支持 IE
![]() IE | ![]() Edge | ![]() Firefox | ![]() Chrome | ![]() Safari |
|---|---|---|---|---|
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |



