servii-backend/readme.md

# Servii - Backend

[![PyPI](https://img.shields.io/pypi/v/PyGithub.svg)](https://pypi.python.org/pypi/PyGithub)
[![Docker Image CI](https://github.com/hubHarmony/servii-backend/actions/workflows/docker-image.yml/badge.svg)](https://github.com/hubHarmony/servii-backend/actions/workflows/docker-image.yml)
![Static Badge](https://img.shields.io/badge/servii-V1.0.0-pink?style=flat)
[![Static Badge](https://img.shields.io/badge/%F0%9F%93%9A-%202.7.1%20-36A4A4)](https://www.servii.fr/api-docs/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
![Static Badge](https://img.shields.io/badge/Python-3.12.3-yellow)


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.

[Firebase]: https://firebase.google.com/
[GitHub]: https://github.com

## Installation guide
#### Download the repository.
```bash
git clone https://github.com/charleslemaux/servii-backend.git
cd servii-backend
```
#### Install virtualenv.
```bash
pip3 install virtualenv
```

#### Enable it.
```bash
virtualenv venv

//UNIX
source venv/bin/activate

//windows
venv\Scripts\activate
```
#### Install dependencies.
```bash
pip install -r requirements.txt
```
#### Launch ! 
```bash
gunicorn -w 4 -b 0.0.0.0:3000 app:app

//You may also mention parameters like this.
gunicorn -w 4 -b 0.0.0.0:3000 app:app --interval 20
```

## 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.

[Documentation]: https://www.servii.fr/api-docs/

## 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.


[charles@le-maux.dev]: mailto:charles@le-maux.dev