Code de l'API utilisé au sein de Mauria
- Client : ViteJS (React) + TypeScript + FlowBite React
- Serveur : ExpressJS + Firebase
Le repo est divisé en deux parties : client et server.
Le côté client est le nouveau front de l'API Mauria permettant une modification plus simple et rapide des données contenues dans Mauria (via Firebase).
Même fonction qu'avant, mais avec une meilleure gestion des erreurs et des logs. Le serveur est hébergé sur Fly.io et est accessible à l'adresse suivante : https://mauriaapi.fly.dev/
Une documentation Swagger a été mise en place pour décrire les différentes routes de l'API.
Tout est disponible ici
- NodeJS
v18+ - npm et/ou yarn
- La clé d'API Firebase (à demander à un admin)
- Cloner le repo
- Se placer dans le dossier du projet :
cd app - Installer les dépendances :
npm i - Lancer le projet :
npm start - Le projet sera accessible à l'adresse indiqué dans la console.
- Mise en place de l'API Aurion x Mauria pour éviter le scrapping et permettre plus de sécurité. (discussion en cours)
Pour contribuer au projet, il faut faire un fork du repo à partir de la branche master.
Une fois votre fork créé, vous pouvez travailler sur votre fork
Pour proposer vos changements, vous devez faire une pull request sur la branche master du repo principal.
Si votre contribution est acceptée (après tests), elle sera déployée instantanément !
Ce projet est sous licence GNU v3. Pour plus d'informations, voir le fichier LICENSE à la racine du projet.