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
45 Commits 2 Branches 0 Tags 186 KiB
Python 79.4%
HTML 19.1%
Dockerfile 1%
Shell 0.5%
8cec0022ed
Go to file
charleslemaux 8cec0022ed
Update readme.md
2024-06-30 18:13:15 +01:00
secrets [~] Latest push 2024-06-29 21:40:26 +01:00
.gitignore [V2+] Secrets added. 2024-06-29 17:13:24 +01:00
api_sender.html [~] Fix : added server state update at /serverStop 2024-06-30 00:46:52 +01:00
app.py [~] Latest push 2024-06-29 21:40:26 +01:00
Dockerfile [V2] Final commit, production ready 2024-06-25 22:49:33 +01:00
file_manager.py [V2+] r'string 2024-06-26 00:23:11 +01:00
firebase_manager.py [~] Firestore : added servers running states 2024-06-30 00:34:54 +01:00
generic_executor.py [~] Fix : added server state update at /serverStop 2024-06-30 00:46:52 +01:00
readme.md Update readme.md 2024-06-30 18:13:15 +01:00
requirements.txt [V2] Final commit, production ready 2024-06-25 22:49:33 +01:00
server_mc_manager.py [V2] Final commit, production ready 2024-06-25 22:49:33 +01:00
unit_test.py [V2+] Secrets added. 2024-06-29 17:13:24 +01:00

readme.md

Servii - Backend

PyPI CI Static Badge Static Badge Code style: black

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.