charleslemaux/servii-backend
1
0
Fork 0
mirror of https://github.com/hubHarmony/servii-backend.git synced 2024-11-17 21:40:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Backend codebase for the servii project
123 Commits 2 Branches 0 Tags 186 KiB
Python 79.4%
HTML 19.1%
Dockerfile 1%
Shell 0.5%
8a282012e3
Go to file
Charles Le Maux 8a282012e3 [+] Updated testing page
2024-09-10 01:05:36 +02:00
.github/workflows [+] Docker workflow 2024-07-15 16:28:16 +01:00
secrets [~] Latest push 2024-06-29 21:40:26 +01:00
servers [+] Global version indexer script 2024-08-20 13:56:15 +02:00
.gitignore [+] Updated gitignore to fit project's needs 2024-08-20 13:53:59 +02:00
api_sender.html [+] Updated testing page 2024-09-10 01:05:36 +02:00
app.py [+] Upload route 2024-09-10 01:05:25 +02:00
cloudflare_manager.py [+] Type & dependencies fixes 2024-08-15 10:49:41 +02:00
docker.sh [+] Full docker support 2024-07-02 07:02:18 +01:00
Dockerfile [+] Full docker support 2024-07-02 05:56:11 +01:00
file_manager.py [+] File extension parser 2024-09-10 01:05:15 +02:00
firebase_manager.py [+] Fixed positional argument in Firestore query 2024-09-09 23:16:30 +02:00
generic_executor.py [+] Idle servers are now automatically stopped. 2024-09-06 12:44:05 +02:00
readme.md [+] Updated mail in readme.md 2024-09-06 18:00:54 +02:00
requirements.txt [+] Werkzeug utils for filename safety 2024-09-07 16:41:56 +02:00
server_mc_manager.py [+] Added exception handling to query 2024-09-06 17:56:56 +02:00
unit_test.py [~] Simple async tests 2024-09-10 00:54:14 +02:00

readme.md

Servii - Backend

PyPI Docker Image CI Static Badge Static Badge Code style: black Static Badge

Servii is a cutting-edge project designed to streamline the management of Minecraft servers and facilitate seamless integration with frontend applications. Built with modern technologies like Firebase, Servii offers a robust backend for launching Minecraft servers and serves as a comprehensive API for frontend projects, enhancing the gaming experience through efficient server management and automation. This GitHub repository has a production goal, workflows will be soon integrated.

Installation guide

Download the repository.

git clone https://github.com/charleslemaux/servii-backend.git
cd servii-backend

Install virtualenv.

pip3 install virtualenv

Enable it.

virtualenv venv

//UNIX
source venv/bin/activate

//windows
venv\Scripts\activate

Install dependencies.

pip install -r requirements.txt

Launch !

gunicorn -w 4 -b 0.0.0.0:3000 app:app

Documentation

The API's {Documentation} is now complete !! This project is self documented and ready to understand. Start reading at app.py, and even if the rest isn't that self explainatory, read the "generic_executor.py' file to understand how everything globally works.

Development

Contributing

Long-term discussion and bug reports are maintained via GitHub Issues. Code review is done via GitHub Pull Requests.

Maintainership

We're actively seeking maintainers that will triage issues and pull requests and cut releases. If you work on a project that leverages Servii and have a vested interest in keeping the code alive and well, send an email to charles@le-maux.dev, thank you for reading.