Hangar 插件仓库搭建与使用教程

Hangar 插件仓库搭建与使用教程

Hangar A plugin repository used for paper plugins 项目地址: https://gitcode.com/gh_mirrors/ha/Hangar

一、项目目录结构及介绍

Hangar 是一个为Paper、Velocity、Waterfall插件及其他相似软件设计的插件仓库。该项目基于Spring Boot框架构建后端，并采用Nuxt（搭配UnoCSS）开发前端界面。下面简要介绍一下其主要的目录结构：

• 根目录

  • backend: 后端代码所在目录，负责核心逻辑处理。
  • frontend: 前端代码目录，包含了Vue.js应用，用于用户交互界面。
  • docker: 包含Docker相关配置，用于本地运行数据库和服务。
  • chart: Helm图表目录，用于部署到Kubernetes环境。
  • CONTRIBUTING.md: 贡献者指南。
  • LICENSE: 许可证文件，遵循MIT协议。
  • README.md: 项目概述文件。

• backend目录 内含Java源码，关键配置文件如application.yml位于src/main/resources中。

• frontend目录 主要是前端资源，入口点在package.json，用于开发和构建命令。

二、项目的启动文件介绍

后端启动

• 核心启动类是HangarApplication，可以通过IDE直接运行，或者通过命令行进入backend目录后使用mvn spring-boot:run来启动。

前端启动

• 前端启动涉及到Node环境，进入frontend目录后执行pnpm install安装依赖，然后运行pnpm run dev启动开发服务器。

三、项目的配置文件介绍

• 主要配置文件: application.yml位于backend/src/main/resources/，它是Spring Boot应用的主要配置文件，定义了应用的行为，包括数据库连接、服务端口等关键设置。

• 数据库和邮件服务配置: 在本地开发时，通过docker-compose脚本（位于docker目录下的dev.yml）来启动并配置临时的数据库和邮件服务，这些配置并不直接反映在application.yml中，而是由Docker环境变量管理。

• 生产环境配置: 部署至生产或测试环境时，配置通常通过Helm图表中的秘钥管理，具体定义在chart/templates/secret-hangar-backend.yaml。

以上就是关于Hangar项目的基本搭建与配置说明。开发者在开始贡献代码或部署项目前，应确保已正确设置了开发环境，并理解这些关键配置和启动流程。

Hangar A plugin repository used for paper plugins 项目地址: https://gitcode.com/gh_mirrors/ha/Hangar