MuYun 开源项目使用教程

MuYun 开源项目使用教程

MuYun 一个云原生、开发者优先、前后端分离、按需插拔的轻代码平台。 项目地址: https://gitcode.com/gh_mirrors/mu/MuYun

1. 项目的目录结构及介绍

MuYun 是一个云原生、开发者优先、前后端分离、按需插拔的轻代码平台。以下是项目的目录结构及各部分功能的简要介绍：

MuYun/
├── .github/               # GitHub 工作流和配置文件
├── config/                # 配置文件目录
├── gradle/                # Gradle 构建文件
├── muyun-authorization    # 授权模块
├── muyun-boot             # 启动模块，包含应用程序的入口点
├── muyun-core-uni         # 核心模块，提供通用功能
├── muyun-core             # 核心模块，提供基础功能
├── muyun-database-std     # 标准数据库访问模块
├── muyun-database-uni     # 通用数据库访问模块
├── muyun-database         # 数据库模块
├── muyun-fileserver       # 文件服务器模块
├── muyun-log              # 日志模块
├── muyun-platform         # 平台模块，提供基础服务
├── muyun-proxy            # 代理模块
├── muyun-runtime-gateway  # 网关运行时模块
├── muyun-runtime-session  # 会话运行时模块
├── .dockerignore          # Docker 忽略文件
├── .editorconfig           # 编辑器配置文件
├── .gitignore             # Git 忽略文件
├── LICENSE.txt            # 许可证文件
├── MuYun轻代码平台能力一览.pdf # 项目简介文档
├── README.md              # 项目说明文件
├── README_QUARKUS.md      # Quarkus 相关的说明文件
├── build.gradle.kts       # Gradle 构建脚本
├── compose.yaml           # Docker Compose 配置文件
├── gradlew                # Gradle Wrapper 脚本
├── gradlew.bat            # Gradle Wrapper 脚本（Windows 版本）
├── settings.gradle.kts    # Gradle 设置文件

2. 项目的启动文件介绍

项目的启动文件位于 muyun-boot 目录下，主要包含以下文件：

• quarkusDev.kts: 使用 Gradle 启动 Quarkus 开发环境的脚本。

要启动项目，可以在项目根目录下执行以下命令：

./gradlew --console=plain :muyun-boot:quarkusDev

该命令会启动 Quarkus 开发环境，并在首次启动时引导用户设置管理员账号密码。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，以下是主要的配置文件及其作用：

• application.properties: 应用程序的基本配置，如数据库连接信息、日志级别等。
• application.yaml: 应用程序的 YAML 格式配置文件，用于定义应用程序的配置。
• logback.xml: Logback 的配置文件，用于定义日志的输出格式和记录级别。

这些配置文件可以根据项目的具体需求进行修改和调整。例如，如果需要更改数据库连接信息，可以在 application.properties 文件中修改相应的配置项。

以上是 MuYun 开源项目的基本使用教程，希望对您有所帮助。

MuYun 一个云原生、开发者优先、前后端分离、按需插拔的轻代码平台。 项目地址: https://gitcode.com/gh_mirrors/mu/MuYun