bepolytech/bepi

Sponsored OSS

By Bureau Étudiant de Polytechnique

Updated almost 2 years ago

BEP's API

Image
Databases & Storage
Languages & Frameworks
Integration & Delivery

4.3K

BEPI - BEP's API : https://api.bepolytech.be/docs

https://github.com/bepolytech/bepi

API server for the local, like the door open status

Built with FastAPI (Python)
API token required for PUT requests (by an ESP8266 microcontroller, like a NodeMCU)
Uses slowapi for rate-limiting (120 requests/min)

Docker : from version 1.2.0 onwards, uses the alpine variant of python base image.

Docs

docs available at https://api.bepolytech.be/docs (or https://api.bepolytech.be/redoc)

Run

setup a .env file in /app (using the provided .env_template file).
then use docker (with provided docker-compose.yml file), run docker-compose up -d.

License

MIT

Contributing

Contribute at https://github.com/bepolytech/bepi

by PLucas 🚀

Docker Pull Command

docker pull bepolytech/bepi