组织介绍

欢迎使用elsfs-cloud

Elsfs Cloud 1.0.0-M1

Enterprise level safety function system

企业级安全功能系统

Coverage Status Downloads Downloads

系统说明

  • 基于 Spring Cloud 2023、Spring Boot 3.2、Spring cloud alibaba 2022
  • spring-oauth2-authorization-server 的 RBAC 权限管理系统
  • 基于数据驱动视图的理念封装 ant-design,即使没有 vue 的使用经验也能快速上手
  • 提供对常见容器化支持 Docker、Kubernetes、Rancher2 支持(待实现)

使用文档

Elsfs Cloud 提供了详尽的部署文档 👉 (http://elsff.com,涵盖开发环境配置、服务端启动、前端运行等关键步骤。

重要的事情说三遍:

快速开始

快速体验

# 可用内存大于4G
# 1. clone仓库
git clone https://github.com/elsfs/elsfs-cloud.git
cd elsfs-cloud

# 2. 导入sql 到数据库
mysql -uroot -p < doc/db/mysql/*.sql
# 3. 修改配置文件数据库用户名密码 webapps/system-application/src/main/resources/config/application.yml
# 4. 构建
./gradlew clean build
# 5. 启动
java -jar webapps/system-application/build/libs/system-application-1.0.0-M1.jar

核心依赖

依赖 版本
Spring Cloud 2024.0.x
Spring Cloud Alibaba 2024.0.x
Spring Authorization Server 1.4.x
Mybatis Plus 3.5.9
Spring Boot 3.4.x

模块说明

elsfs-cloud

├─── api -- api接口相关
     ├── api-security -- 安全api
     ├── api-validation -- 验证api
└── common -- 系统公共基础模块
     ├── annotations -- 注解
     ├── core -- 系统公共核心
     ├── excel -- excel相关
     ├── mybatis -- mybatis相关
     ├── pay -- 支付相关
     ├── redis -- redis相关
     ├── security -- 认证授权相关
     ├── sms -- 短信相关
     ├── swagger -- swagger相关
     ├── utils -- 工具类
     ├── validation -- validation验证相关
     ├── webs -- web公共配置相关
└── demo-webapps web示例
     └──  mq -- mq相关
     └──  security -- 认证授权相关
└──  文档
     ├── db  -- 数据库脚本
     ├── virtualization -- 虚拟化相关
└──  gradle -- 框架相关
     ├──  pmd -- pmd 规则
     ├──  gstyle -- 代码规范
├──  libs -- 外部包相关     
└── module -- 业务相关
     ├── ai -- ai 实现相关
     ├── cms -- cms 实现相关
     ├── config -- config 实现相关
     ├── datasource -- datasource 实现相关
     ├── dict -- dict 实现相关
     ├── oss -- oss 实现相关
     ├── permission -- permission 实现相关
     ├── system -- system 实现相关
     ├── tenant -- tenant 实现相关
└── starter  -- spring starter
     ├── authorizationserver-server-boot-starter  -- oauth2 授权服务器启动
     ├──  elsfs-screw-spring-starter -- screw 启动
     ├──  excel-spring-boot-starter -- excel 启动
     ├──  login-spring-boot-starter -- login 启动
└── webapps  -- 启动类
     ├── auth-application -- 认证授权服务
     ├── front-application -- 前端服务
     ├── monitor-application -- 监控服务
     ├── nacos-dashboard -- nacos dashboard
     ├── sentinel-dashboard -- sentinel 启动
     ├── system-application -- 系统服务

使用说明

  1. clone 项目
平台 地址
gitee https://gitee.com/jglab/elsfs-cloud
github https://github.com/elsfs/elsfs-cloud
文档贡献 https://gitee.com/jglab/elsfs-cloud-doc
文档地址 https://elsff.com
前端代码(gitee) https://gitee.com/jglab/elsfs-admin
  1. 构建项目
cd elsfs-cloud
# 构建代码
./gradlew package -P dev
# 代码检查
./gradlew  checkstyle:check -P check
#    代码格式化
./gradlew spotless:apply -P check

参与贡献

  1. 欢迎提交 PR, 代码规范 google-java-javaformat

    代码规范说明
    1. 由于 google-java-format 强制所有代码按照指定格式排版,未按此要求提交的代码将不能通过合并(打包)
    2. 具体配置参考csdn 使用谷歌 Java 开发规范
    3. 其他开发工具,请参考 google-java-format 说明,或提交代码前在项目根目录运行下列命令(需要开发者电脑支持mvn命令)进行代码格式化
       # 代码检查
       ./gradlew  checkstyle:check -P check
       #    代码格式化
       ./gradlew spotless:apply -P check
  2. 欢迎提交 issue,请写清楚遇到问题的原因、开发环境、复显步骤。

  3. 联系作者 mailto:maicaii@vip.qq.com

成就
114
Star
7
Fork
成员(1)
12722352 elsfs 1703599382
elsfs

搜索帮助