Skip to content
This repository was archived by the owner on Sep 28, 2025. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# API
Code de l'API utilisé au sein de Mauria
Code de l'API utilisée au sein de Mauria

## Technologies utilisées

- Client : ViteJS (React) + TypeScript + FlowBite React
- Serveur : ExpressJS + Firebase
- Client : Vite (React) + TypeScript + Flowbite React
- Serveur : Express.js + Firebase

## Structure du projet

Le repo est divisé en deux parties : `client` et `server`.

### Client

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).
La partie client est le nouveau front-end de l'API Mauria permettant une modification plus simple et rapide des données contenues dans Mauria (via Firebase).

### Server
### Serveur

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/`
Même fonction qu’auparavant, 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/`](https://mauriaapi.fly.dev/).


## Documentation

Une documentation Swagger a été mise en place pour décrire les différentes routes de l'API.

Tout est disponible [ici](https://mauriaapi.fly.dev/docs)
Tout est disponible [ici](https://mauriaapi.fly.dev/docs).

## Installation

### Prérequis

- NodeJS `v18+`
- Node.js `v18+`
- npm *et/ou* yarn
- La clé d'API Firebase (à demander à un admin)

Expand All @@ -39,21 +39,22 @@ Tout est disponible [ici](https://mauriaapi.fly.dev/docs)
2. Se placer dans le dossier du projet : `cd app`
3. Installer les dépendances : `npm i`
4. Lancer le projet : `npm start`
5. Le projet sera accessible à l'adresse indiqué dans la console.
5. Le projet sera accessible à l'adresse indiquée dans la console.


## Roadmap

- Mise en place de l'API Aurion x Mauria pour éviter le scrapping et permettre plus de sécurité. (discussion en cours)
- Mise en place de l'API Aurion × Mauria pour éviter le scraping et améliorer la sécurité.\
La discussion est en cours.


## Contribution

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
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 !

## License
Ce projet est sous licence GNU v3. Pour plus d'informations, voir le fichier `LICENSE` à la racine du projet.
## Licence
Ce projet est sous licence GNU GPL v3. Pour plus d'informations, voir le fichier `LICENSE` à la racine du projet.
2 changes: 1 addition & 1 deletion client/src/pages/Login.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const LoginPage: React.FC = () => {
<form className="flex max-w-md flex-col gap-4">
<div>
<div className="mb-2 block">
<Label htmlFor="email1" value="Mail Junia (administrateur)" />
<Label htmlFor="email1" value="Mail JUNIA (administrateur)" />
</div>
<TextInput id="email1" type="email" placeholder="prenom.nom@...junia.com" required
onChange={(e) => setEmail(e.target.value)}
Expand Down