Efiriyad API ·

Spécialités

• HGGSP #hggsp
• HLP #hlp
• Anglais OP #english-op
• Mathématiques #math
• Physique-Chimie #physics
• SVT #svt
• SES (Ziad) #ses

Cours obligatoires

• Francais #french
• Histoire-Géo #hist-geo
• EMC #emc
• Enseignement scientifique #science
• Anglais #english
• Sport #sport
• LVB #lvb
• LVC #lvc

LVB

• Allemand #german
• Arabe (Ziad) #arabic
• Espagnol (Ziad) #spanish

LVC

• EPS OP #sport-op
• Arts-Plastiques #art

---

• Installation
  • For development
  • For production
• Environment Variables
• Usage
• License

Installation

The first step will be to clone the repo

git clone https://github.com/efiriyad/api.git

For development

The requirements are:

• Python and Poetry

1. Install the dependencies

   poetry install

For production

Using Docker is generally recommended (but not strictly required) because it abstracts away some additional set up work.

The requirements for Docker are:

• Docker CE
• Docker Compose
  • pip install docker-compose
  • This is only a required step for linux. Docker comes bundled with docker-compose on Mac OS and Windows.

Environment Variables

To run this project, you will need to add the following environment variables.

Variable	Description	Default
API_NAME	The name of the API	"FastAPI"
API_ENDPOINT	The endpoint of the API	"/api/v1"
API_HOST	The API host	"0.0.0.0"
API_PORT	The API port	8080
FIREBASE_PROJECT_ID	The Firebase project ID	* Required
FIREBASE_PRIVATE_KEY	The Firebase private key	* Required
FIREBASE_CLIENT_EMAIL	The Firebase client email	* Required
DEBUG	Toggles debug mode	False

Usage

Now you are done! You can run the project using Docker

docker-compose up

Or start the API manually with

poetry run task start

License

Distributed under the MIT License. See LICENSE for more information.