South Admin React

如果您觉得该项目对您有所帮助或者您喜欢我们的项目，请在 GitHub 上给我们一个 ⭐️。如果您有改进或新增功能的意愿欢迎提交 issues，感谢您的支持！

✨ 简介

使用React,Typescript,Vite,Antd等主流技术开发的开箱即用的中后台前端项目，Vite实现自动生成路由，支持KeepAlive功能，zustand状态管理，支持虚拟滚动表格，UnoCss开发样式。

🚀 项目演示

演示地址，接口数据都为mock数据，无法进行新增和修改。

💻 安装使用

• 获取项目代码

git clone https://github.com/southliu/south-admin-react.git

• 选择目录

cd south-admin-react

• 安装全局依赖依赖，存在则不用安装

npm i -g pnpm

• 安装依赖

pnpm install -w

如果使用pnpm安装依赖出现安装失败问题，请使用梯子、yarn安装或切换淘宝源。

pnpm config set registry https://registry.npmmirror.com

• 运行

pnpm dev

• 打包

pnpm build

后端项目

python: south-admin-django

快速编码

使用vscode的代码片段，在.vscode/south.code-snippets文件中预设了demoPage、demoModel、demoApi等常用代码片段，后续对代码片段不满意可以修改对应的body代码。

1. 打开vscode，在src/pages目录下创建你所需的文件夹，以log为例，创建一个log文件夹。
2. 在log文件夹下创建model.ts文件，在该文件下输入demoModel后回车，会出现对应的代码片段。
3. 在src/servers文件夹下面创建一个log.ts文件，在该文件下输入demoApi后回车，将XXX改为Log，将xxx改为接口路由。
4. 在log文件夹下创建index.ts文件，在该文件下输入demoPage后回车，将XXX改为Log，将xxx改为对应权限表示。

TODO

• 分页下拉框，触底加载下一页
• 列筛选添加拖拽功能
• 列筛选添加重置功能
• 外链菜单
• 优化代码，减少不必要的重渲染
• 开发python后端

📁 项目结构

south-admin-react
├── build                     # 构建相关配置
│   ├── utils                 # 构建工具函数
│   └── vite                  # vite 配置
├── packages                  # monorepo子包
│   ├── message               # 消息模块
│   ├── request               # 请求模块
│   ├── stylelintConfig      # stylelint配置
│   └── utils                 # 工具函数
├── public                    # 静态资源
├── src                       # 源代码
│   ├── assets                # 静态资源
│   │   ├── css               # 样式文件
│   │   └── fonts             # 字体文件
│   ├── components            # 公共组件
│   │   ├── Form              # 表单组件
│   │   └── Table             # 表格组件
│   ├── layouts               # 布局组件
│   │   └── components        # 布局子组件
│   ├── locales               # 国际化配置
│   ├── menus                 # 菜单配置
│   ├── pages                 # 页面
│   │   ├── content           # 内容管理
│   │   └── system            # 系统管理
│   ├── router                # 路由配置
│   ├── servers               # API 接口
│   ├── stores                # 状态管理
│   └── utils                 # 工具函数
├── types                     # TS类型定义
├── .eslintrc.cjs             # ESLint 配置
├── .gitignore                # Git 忽略文件
├── index.html                # HTML 模板
├── package.json              # 项目依赖
├── tsconfig.json             # TypeScript 配置
└── vite.config.ts            # Vite 配置

🧩 图标(iconify)

• 参考 iconify官方地址
• VS Code安装Iconify IntelliSense - 图标内联显示和自动补全

🎗️ Git 提交示例

Git提交不规范会导致无法提交，feat关键字可以按照下面Git 贡献提交规范来替换。

git add .
git commit -m "feat: 新增功能"
git push

按照以上规范依旧无法提交代码，请在终端执行npx husky install之后重新提交。

🎯 Git 贡献提交规范

• 参考 vue 规范

  • feat 增加新功能
  • fix 修复问题/BUG
  • style 代码风格相关无影响运行结果的
  • perf 优化/性能提升
  • refactor 重构
  • revert 撤销修改
  • test 测试相关
  • docs 文档/注释
  • chore 依赖更新/脚手架配置修改等
  • workflow 工作流改进
  • ci 持续集成
  • types 类型定义文件更改
  • wip 开发中

🐵 关于封装

1. 功能扩展，在原有的api上拓展。
2. 功能整合，合并两个或两个以上组件的api。
3. 样式统一，避免后期样式变动，导致牵一发而动全身。
4. 公共组件二次封装或常用组件使用Base开头，便于区分。

📕 Q&A常见问题

1. 页面权限如何配置？

1. 通过登录接(/user/login)或重新授权接口(/user/refresh-permissions)获取permissions权限数据。
2. 通过菜单接口(/menu/list)获取data中的rule权限数据，这个rule数据影响菜单显示，如果没返回rule则一直都显示。
3. 页面内权限参考src/pages/system/menu.index.tsx文件内的pagePermission数据，pagePermission.page是显示页面的权限，根据第一点返回的permissions进行匹配。

2. 路由如何配置？

路由根据文件夹路径自动生成，路径包含以下文件名或文件夹名称则不生成：

• login
• forget
• components
• utils
• lib
• hooks
• model.tsx
• 404.tsx

可自行在 src/router/utils/config.ts 修改路由生成规则。

3. 菜单如何配置？

提供了两种方式配置菜单：

1. 动态菜单，通过菜单接口(/menu/list)获取菜单数据。
2. 静态菜单，需要静态菜单将/src/hooks/useCommonStore.ts中的useCommonStore中的menuList改为defaultMenus。

// src/hooks/useCommonStore.ts
import { defaultMenus } from '@/menus';

// const menuList = useMenuStore(state => state.menuList);
// 菜单数据
const menuList = defaultMenus;

4. @south/xxx依赖在哪查看？

通过根目录packages文件中查看对于xxx文件的源码进行修改。

5. 安装新依赖时报错？

使用了monorepo项目安装新依赖时需要在后面添加-w或--workspace，否则会报错，比如：pnpm i mobx -w。

🧡 捐赠

如果您觉得这个项目对您有帮助，您可以帮作者买一杯咖啡表示支持!

微信	支付宝