diff --git a/README.md b/README.md index 3e35dc4e24a049eaeb030de5f2ae3841cb604f7f..a338c22a6120412c2958a62092fc7456b0733302 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ +# Nebula Framework +
- Nebula Logo + Nebula Logo
+

Nebula Framework

- ## 介绍 Nebula Framework 是一套基于 Spring Boot 3.0 和 Java 17 开发的企业级后台管理开发平台。并且以DDD(领域驱动设计)为理念,它由多个模块组成,每个模块都针对特定的功能需求设计,以提供灵活且高效的开发体验。 @@ -21,16 +23,14 @@ Nebula Framework 是一套基于 Spring Boot 3.0 和 Java 17 开发的企业级 ## 功能特点 - **灵活的模块化设计**:模块化的设计使得开发者可以根据需求选择合适的模块进行集成。 -- **权限管理**:集成了完善的登录验证及权限验证机制,保障系统安全。 -- **代码生成**:提供基于 Maven 插件的代码生成工具,提高开发效率。 -- **企业级开发**:基于 Spring Boot 3.0 和 Java 17,适合企业级应用开发。 -## 领域驱动设计(DDD) +## 领域驱动设计 (DDD) -整个后台框架的业务代码遵循 DDD(领域驱动设计)规范。DDD 是一种软件设计方法,它将业务需求紧密地反映在系统设计的模型中,强调以业务概念为驱动的软件开发。Nebula Framework 提供了一套基于 DDD 的代码架构,但这个规范是灵活的,可以根据个人或项目的不同需求进行调整。在必要的时候,开发者可以根据自己的方式编写代码,不拘泥于固定的模式。 +本项目基于领域驱动设计的理念,将业务逻辑与技术实现分离,提高系统的可维护性和可扩展性。 ## 安装教程 -## 后端环境搭建 + +### 后端环境搭建 ```bash $ git clone https://gitee.com/neegix-opensource-group/nebula-framework @@ -41,12 +41,9 @@ $ git clone https://gitee.com/neegix-opensource-group/nebula-framework $ cd nebula-framework ``` - - -安装依赖 - +安装依赖: ```bash - mvn clean install +mvn clean install ``` 然后进入启动项目目录: @@ -54,13 +51,13 @@ $ cd nebula-framework $ cd neblua-framework-organization ``` -修改配置文件(**开发环境**) +修改配置文件(开发环境): ```bash $ vim src/main/resources/application-dev.yml ``` -修改数据库配置(改成自己的数据库相关环境参数) -```bash +更新数据库配置(更改为您自己的数据库环境参数): +```yaml spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver @@ -69,13 +66,11 @@ spring: password: 12345678 ``` -启动 +启动应用: ```bash - mvn spring-boot:run +$ mvn spring-boot:run ``` -- [nebula-framework-generator 安装指南](https://nebula.neegix.com/nebula/nebula-framework/nebula-framework-generator/) - ## 使用说明 详细使用说明请访问 [Nebula Framework 官网](https://nebula.neegix.com)。 @@ -99,17 +94,10 @@ spring: [Nebula Framework 官网](https://nebula.neegix.com) -#### 联系信息 +## 联系信息 - -[//]: # ( ) - - - - -[//]: # ( )
QQ 群: 996598075Discord: https://discord.gg/WrP5J9Ea7z
\ No newline at end of file