https://github.com/InvalidJoker/MiniCloud

https://github.com/InvalidJoker/MiniCloud

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/InvalidJoker/MiniCloud
• Owner: InvalidJoker
• Created: 2024-08-05T17:58:58.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-08T09:53:59.000Z (4 months ago)
• Last Synced: 2024-09-08T12:01:02.776Z (4 months ago)
• Language: Go
• Size: 126 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Minicloud

> Minicloud is a small Minecraft cloud system that allows you to run Minecraft servers easily.

## Features

- Easy to use **(WIP)**

- Fast: We use Golang for the backend with Gate as the proxy.

- Secure: All servers are isolated with Docker.

- Scalable: You can run as many servers as you want.

## Installation

> TODO

## Development

### Requirements

- [Docker](https://docs.docker.com/get-docker/)

- [Go](https://go.dev/doc/install)

### Setting up the project

1. Clone the repository

2. Setup the database with `docker compose -f dev.compose.yml up -d`

3. Copy the example.dev.config.json to config.json

4. Run the project with `go run cmd/plugin.go`

## Credits

- [Gate](https://gate.minekube.com/) for the proxy and the github actions.