Merge pull request #113 from Gml-Launcher/develop

Develop

Author: GamerVII-NET

Gml.Backend.sln

@@ -78,6 +78,15 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Modrinth.Api.Domains", "src
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Gml.Backend.Tests", "tests\Gml.Backend.Tests\Gml.Backend.Tests.csproj", "{13D5F0F1-77B7-4415-BE69-2C1109E96348}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "libs", "libs", "{079E0363-DE4D-43DD-86BB-99D921E6D2EE}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Gml.Core", "Gml.Core", "{065BF79A-E3D4-48E2-9675-02C1A3974182}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "modrinth", "modrinth", "{71792E05-B97A-4861-87D4-2B176A004FA3}"
+	ProjectSection(SolutionItems) = preProject
+		src\Gml.Web.Api\src\Gml.Core\src\Modrinth.Api\README.md = src\Gml.Web.Api\src\Gml.Core\src\Modrinth.Api\README.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -183,5 +192,8 @@ Global
 		{1810C95B-E7A2-4C34-A091-522EE3E75C25} = {E2ED9D08-3137-4328-8544-CE413F2B73B8}
 		{3E7FC536-9C83-40C8-95AA-D221930756FB} = {E2ED9D08-3137-4328-8544-CE413F2B73B8}
 		{13D5F0F1-77B7-4415-BE69-2C1109E96348} = {AA158165-09EE-4338-9FC8-9F172E47F62D}
+		{079E0363-DE4D-43DD-86BB-99D921E6D2EE} = {C8F55A92-E612-4AAE-9586-8E33D170A266}
+		{065BF79A-E3D4-48E2-9675-02C1A3974182} = {079E0363-DE4D-43DD-86BB-99D921E6D2EE}
+		{71792E05-B97A-4861-87D4-2B176A004FA3} = {079E0363-DE4D-43DD-86BB-99D921E6D2EE}
 	EndGlobalSection
 EndGlobal

README.md

@@ -1,28 +1,98 @@
-![Banner](https://github.com/user-attachments/assets/7a2671d6-76a1-406d-9294-8d3a754f0398)
+![Frame 39262](https://github.com/user-attachments/assets/4ac0a227-a246-474a-8aab-1af34b6f8497)
 
+# Gml.Backend
 
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Gml-Launcher/Gml.Web.Api/docker-package-publish.yml?label=Tests&style=for-the-badge&branch=master)
-![GitHub contributors](https://img.shields.io/github/contributors/Gml-Launcher/Gml.Backend?style=for-the-badge)
-![Size](https://img.shields.io/github/repo-size/Gml-Launcher/Gml.Backend?style=for-the-badge)
-![License](https://img.shields.io/github/license/Gml-Launcher/Gml.Backend?style=for-the-badge)
+Gml.Backend is a comprehensive project designed to facilitate rapid deployment of server infrastructure for Minecraft game profiles, including Forge, Fabric, and LiteLoader. This product suite encompasses three integral services:
 
-# Gml.Backend 
+- **Gml.Web.Api**: A RESTful API that provides an interface for interaction with server data.
+- **Gml.Web.Client**: Commonly referred to as the Monitoring Dashboard, this component offers a user-friendly interface for monitoring and administrating game profiles and the launcher.
+- **Gml.Web.Skin.Service**: A service dedicated to the management of textures, allowing for customization and personalization for each player.
 
-Gml.Backend is a comprehensive project, designed to facilitate rapid deployment of server infrastructure for Minecraft game profiles: Forge, Fabric, LiteLoader.
-This product suite encompasses three integral services:
+Together, these services offer a robust foundation for managing Minecraft game profiles with mods.
 
-[Gml.Web.Api:](https://github.com/Gml-Launcher/Gml.Web.Api) This is a RESTful API that provides an interface for interaction with server data.
+## Documentation
+- [Official Website](https://gml.recloud.tech)
+- [Official Documentation](https://wiki.recloud.tech)
+- [Wiki Mirror](https://gml-launcher.github.io/Gml.Docs)
 
-[Gml.Web.Client:](https://github.com/Scondic/Gml.Web.Client) Commonly referred to as the Monitoring Dashboard, this component offers a user-friendly interface for monitoring and administrating game profiles and the launcher.
+## Installation Instructions
 
-[Gml.Web.Skin.Service:](https://github.com/Gml-Launcher/Gml.Web.Skin.Service) This service is specifically dedicated to the management of textures, allowing for customization and personalization for each player.
+### Step 1: Clone the Repository
+Clone the stable version of the repository using the following command:
 
-Together, these services offer a robust foundation for managing Minecraft game profiles with mods.
+```bash
+git clone --recursive https://github.com/GamerVII-NET/Gml.Backend.git
+```
+
+### Step 2: Navigate to the Project Directory
+Move to the project directory:
+
+```bash
+cd Gml.Backend
+```
+
+### Step 3: Configure the `.env` File
+Create or edit the `.env` file in the root of the `Gml.Backend` directory. Below is an example configuration:
+
+```plaintext
+# User and Group Identifiers for Linux
+UID=0
+GID=0
+
+# Security key (replace with your own secure key)
+SECURITY_KEY=643866c80c46c909332b30600d3265803a3807286d6eb7c0d2e164877c809519
+
+# Project settings
+PROJECT_NAME=GmlBackendPanel
+PROJECT_DESCRIPTION=
+PROJECT_POLICYNAME=GmlServerPolicy
+PROJECT_PATH=
+
+# S3 Configuration
+S3_ENABLED=true
+MINIO_ROOT_USER=GamerVII
+MINIO_ROOT_PASSWORD=waefawegferyjerthdrthrtrdthdr
+
+# External Access Settings
+MINIO_ADDRESS=:5009
+MINIO_ADDRESS_PORT=5009
+MINIO_CONSOLE_ADDRESS=:5010
+MINIO_CONSOLE_ADDRESS_PORT=5010
+PORT_GML_BACKEND=5000
+PORT_GML_FRONTEND=5003
+PORT_GML_FILES=5005
+PORT_GML_SKINS=5006
+
+# Microservices
+SERVICE_TEXTURE_ENDPOINT=http://gml-web-skins:8085
+```
+
+### Step 4: Configure the Client `.env` File
+Create or edit the `.env` file in the `src/Gml.Web.Client/` directory:
+
+```plaintext
+# Web API address
+NEXT_PUBLIC_BACKEND_URL=http://localhost:5000/api/v1
+```
+
+### Step 5: Launch the Project with Docker
+Ensure Docker is installed and running on your system. Then, execute the following command to build and start the project:
+
+```bash
+docker compose up -d --build
+```
 
-# Documentation
-[Official Website](https://gml.recloud.tech)
+Docker will download the necessary images and launch the project. Once the containers are running, you can access the services in your browser at the following addresses:
 
-[Official documentation](https://wiki.recloud.tech)
+## Infrastructure
+> **Note**: Starting from version `0.1.0-rc1`, server files are stored in the installation directory. [Learn more](#).
 
-[Wiki mirror](https://gml-launcher.github.io/Gml.Docs/home.html)
+### Server Infrastructure
+- **Web API**: `http://localhost:5000` (Main service)
+- **Web Dashboard**: `http://localhost:5003` (Requires registration)
+- **Gml.Web.Skin.Service**: `http://localhost:5006` (Accessible only within the container)
 
+## Important Notes
+- **FileBrowser** has been removed starting from version `0.1.0-rc1`. [Details](#).
+- **Minio** has been removed starting from version `1.0.3`. [Details](#).
+- Ensure the `.env` files are correctly configured before launching the project. Update the configurations as needed based on your requirements.