2 Star 11 Fork 6

FaberSober / fa-antd-admin

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Get Start

演示地址:http://fa.dward.cn/login 演示地址(备用):http://47.105.146.245:8580/login 演示账户:admin/888888

Git Submodule

项目将多个子模块进行了拆分,使用 git submodule 来管理多个 repo。

git clone --recurse-submodules git@github.com:FaberSober/fa-antd-admin.git

预览

light dashboard-light.png

dark dashboard-dark.png

项目说明

一个前后端分离的 springboot 项目,未使用微服务,部署简单。maven 一键打包前后端代码,只需部署一个最终的 jar 来启动服务。适合小型项目。

  • 前端:react18 + antd5.x + vite3(快速开发 + 打包生产)
  • 后端:springboot2.4.x
  • 环境:mysql5.7 + redis4

开发说明

  1. 复制配置文件application-dev.yml.sampleapplication-dev.yml,修改数据库、redis等配置为本机配置环境。
  2. 启动后端服务:fa-admin/src/main/java/com/faber/AdminBootstrap.java。启动服务后,会自动执行建表 sql,初始化数据库。
  3. 启动前端服务,
    1. 进入前端项目地址:cd fa-frontend
    2. 安装依赖:pnpm i (如果没有按照pnpm,需要先安装:npm install -g pnpm)
    3. 如果遇到canvas: Running install script...执行很久的情况,可以使用安装命令:pnpm i --ignore-scripts
    4. 启动项目:pnpm dev

打包部署

  1. 在项目根目录下执行:mvn clean package -Dmaven.test.skip=true
  2. 服务 jar 包为:fa-admin/target/fa-admin.jar
  3. 启动 jar 包:java -jar fa-admin/target/fa-admin.jar
  4. 访问地址:http://127.0.0.1

目录说明

├─doc                   # 文档
├─docker                # docker环境部署文件
├─fa-admin              # java服务端
├─fa-core               # java core核心公用代码包
├─fa-base               # java base基础通用业务 代码包
├─fa-admin-server       # springbootadmin监控服务
├─frontend              # pnpm monorepo结构前端代码

使用插件

后端

插件 说明 官网
MyBatis-Plus 数据库操作增强 https://baomidou.com/
easyexcel excel 操作 https://easyexcel.opensource.alibaba.com/
Spring Validation 参数校验 http://www.45fan.com/article.php?aid=1D2CNY5HBM62RmJc/
guava google 工具包 https://github.com/google/guava/
hutool 常用工具包 https://hutool.cn/docs/
hutool-crypto 对称加密-SymmetricCrypto https://www.hutool.cn/docs/#/crypto/%E5%AF%B9%E7%A7%B0%E5%8A%A0%E5%AF%86-SymmetricCrypto?id=%e4%bb%8b%e7%bb%8d
UserAgentUtil HTTP 接口客户端参数解析 https://hutool.cn/docs/#/http/UA%E5%B7%A5%E5%85%B7%E7%B1%BB-UserAgentUtil/
redisson redis 缓存 https://github.com/redisson/redisson/
jetcache 通用缓存访问框架 https://github.com/alibaba/jetcache/
Redis Manager Redis 在线管理 https://github.com/ngbdf/redis-manager/
phpRedisAdmin Redis 在线管理 https://github.com/erikdubbelboer/phpRedisAdmin/
Forest 声明式 HTTP 客户端框架 https://forest.dtflyx.com/
spring-file-storage 文件存储框架 https://spring-file-storage.xuyanwu.cn/
easy-es ES工具包 https://www.easy-es.cn/

前端

插件 说明 官网
vite vitejs 构建 https://www.vitejs.net/
vite-plugin-pages 目录路由生成 https://github.com/hannoeru/vite-plugin-pages
react-router v6 路由 https://github.com/hannoeru/vite-plugin-pages
antd antd 前端组件 https://ant-design.gitee.io/components/overview-cn/
fa-cron-react-editor cron 编辑器 https://github.com/xrutayisire/react-js-cron
use-bus bus 事件通知 https://github.com/fabienjuif/use-bus
tailwindcss tailwindcss https://tailwindcss.com
react-use React Hooks — � https://github.com/streamich/react-use
ahooks ahooks.js https://ahooks.js.org/
tinymce 富文本编辑器 https://github.com/tinymce/tinymce
fontawesome 图标库 https://fontawesome.com/
dnd-kit 拖动库 https://dndkit.com/
tree-node-cli list dir as tree https://github.com/yangshun/tree-node-cli
react-grid-layout 网格布局 https://github.com/react-grid-layout/react-grid-layout
@react-pdf-viewer pdf 查看 https://github.com/react-grid-layout/react-grid-layout
@onlyoffice/document-editor-react office 文件在线编辑 https://api.onlyoffice.com/
@uiw/react-amap 高德地图 高德地图 https://uiwjs.github.io/react-amap/
react-device-detect 浏览器判断 https://github.com/duskload/react-device-detect/
prismjs 代码样式 http://prismjs.com/
katex 公式 https://katex.org/

Docker 部署环境文件

  1. redis: docker/redis/docker-compose.yml
  2. phpRedisAdmin: docker/phpRedisAdmin/docker-compose.yml

项目开发使用到的地址

  1. http://localhost/swagger-ui.html
  2. druid 数据源:http://localhost/druid/index.html
  3. 代码生成:http://localhost:7777

详细文档

前台

  1. 升级 npm 依赖
  2. env 环境变量
  3. 登录页面
  4. bus 事件总线
  5. socketio
  6. 拖动排序
  7. CSS

后台

  1. 数据库初始化
  2. 后台约定的一些规则
  3. API 路径定义
  4. 枚举
  5. 注解
  6. 代码生成器
  7. socketio
  8. nginx 部署
  9. mybatisplus
  10. 参考资料

RoadMap

  • 账户表改为逻辑删除
  • 不能删除自身账户和 admin 账户
  • 权限 rbac_menu#link_url 不能重复
  • 优化权限菜单操作、展示效果
  • 删掉无用的 Bean 属性
  • 登录设备日志记录
  • 个人登录历史
  • 在线账户管理
  • 单点登录控制
  • 请求 URL 日志记录
  • 请求 URL 增加注解,拦截时获取注解说明
  • 权限使用注解拦截校验
  • 定时任务执行日志
  • 定时任务 corn 图形化选择
  • 七牛云 demo 示例
  • 阿里云 demo 示例
  • tinymce 编辑器集成
  • pdf 阅读器集成
  • 切换 MyBatis-Plus,delState 类型变更为 int
  • SpringDoc:https://blog.csdn.net/wdj_yyds/article/details/125174042
  • 前端 tree 结构的根结点 ID 切换为 0,并使用统一的枚举值
  • 导出 Excel 需要适配 Enum 类型属性的转换
  • 剔除多余的 hooks 使用
  • socket 整理
  • socket 连接加入 auth
  • 集成 Spring Validation
  • 集成 redis 缓存方案
  • 集成 redis 在线管理工具
  • 组合查询功能模块整理
  • 组合查询功能-扩展-支持 mysql json 格式字段过滤查询
  • 导出 Excel-扩展-支持 mysql json 格式字段导出
  • 表联合查询组合查询功能
  • 使用 https 访问后,druid 访问 nginx 302 问题处理
  • BaseBiz 查询分组 List
  • 表格高度固定
  • 数据库 tinyint 是否类字段在 ORM 映射中统一修改为 Bool 类型
  • 数据库 del_state 字段名称统一修改为 deleted,
  • 使用 dnd-kit 替换现有的拖动排序
  • 使用 react-contexify 替换现有的右键菜单
  • 国际化
  • 图标 ℹ️ 技术整理
  • 图表 📈 技术整理
  • 通用导入方法
  • 多租户
  • ES
  • 流程引擎
  • 报表功能
  • 系统配置-基础配置
  • 系统配置-文件配置
  • 系统配置-邮件配置
  • 系统配置-短信配置
  • 短信验证码逻辑
  • 短信发送历史记录
  • TabBar Extra Tools
  • Dashboard
  • Code Generator
  • Http Utils
  • Frontend use pnpm workspace.
  • APK 打包上传接口(用于 CI).
  • APK 增加记录下载次数
  • Office 文件在线编辑
  • 数据库升级模块优化
  • 队列DEMO-kafka
  • 亮色、暗色模式切换
  • 亮色、暗色模式各组件展示
  • mybatis-plus动态指定表名DEMO
  • 菜单布局适配手机
  • DOC-增加文档查看次数统计
  • DOC-编辑文档网页权限校验
  • 大屏-常见大屏示例开发

CHANGELOG

mvn 更新命令

  1. mvn versions:display-dependency-updates scans a project's dependencies and produces a report of those dependencies which have newer versions available.
  2. mvn versions:display-plugin-updates scans a project's plugins and produces a report of those plugins which have newer versions available.
  3. mvn versions:display-property-updates scans a project and produces a report of those properties which are used to control artifact versions and which properies have newer versions available.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

前端react18 + antd5.x + vite3,后端springboot2.4.x,环境mysql5.7 + redis4。前后端分离,mvn一键打包,jar部署前后端。 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/faberxu/fa-antd-admin.git
git@gitee.com:faberxu/fa-antd-admin.git
faberxu
fa-antd-admin
fa-antd-admin
main

搜索帮助