Hangar

Overview

Hangar is a plugin repository designed for Paper, Velocity, and Waterfall plugins, along with similar software. It is an open-source project rebuilt using Spring Boot for the backend and Nuxt (with UnoCSS) for the frontend, inspired by the Sponge project’s Ore. Hangar offers both a production instance and a staging instance for testing purposes.

Features

• Frontend: Developed using Vue.js under Nuxt with UnoCSS.
• Backend: Built using Spring Boot framework in Java.
• Database: Utilizes PostgreSQL for data storage.
• Development Setup: Easily fork the project, set up Docker for running the PostgreSQL database and a dummy email server, and use Java 17 or higher along with Git for version control.
• Local Installation: Simple setup steps to run the project locally, including starting the database, initiating the backend, and building the frontend.
• Deployment: Uses a Helm chart for deployment, with a configuration file provided in the /chart folder.
• Translations: Utilizes Crowdin for managing translations, offering contributors an easy way to contribute to localization efforts.

Installation

To install Hangar locally, follow these steps:

1. Get the dummy database, storage, and email server running by navigating to the docker folder (cd docker) and running docker-compose -f dev.yml up -d.
2. Move to the backend directory (cd ../backend) and run mvn spring-boot:run.
3. Proceed to the frontend directory (cd ../frontend) and run pnpm install followed by pnpm run dev.
4. Access Hangar at http://localhost:3333 after completing the above steps successfully.

Summary

Hangar serves as a plugin repository with a focus on Paper, Velocity, and Waterfall plugins. It offers a well-structured development setup, easy local installation process, and efficient deployment via a Helm chart. With Crowdin integration for translations, Hangar provides a platform for contributors to localize the project effectively.