From 083b5559c9fd10558e848042917a2d10e8354f38 Mon Sep 17 00:00:00 2001 From: Romain Mallard Date: Fri, 1 May 2026 12:20:24 +0200 Subject: [PATCH] FIX: readme formating --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 45ea637..c679c0d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # hotel-api-rs -##Description +## Description Ce projet est un proof of concept servant de terrain d'expérimentation pour un outil interne destiné à des hotels. -Objectif: +### Objectif: -Petite échelle: ~50 hôtels maximum, ~5 utilisateurs par hôtel -Facilité de maintenance, y compris pour des utilisateurs peu à l'aise avec Linux @@ -18,7 +18,7 @@ Ce projet m'a persmis de découvrir et mettre en pratique : -GitActions -SQlite -##Fonctionalités +## Fonctionalités -CRUD (rooms, inventory, chat) -Authentification : @@ -27,14 +27,14 @@ Ce projet m'a persmis de découvrir et mettre en pratique : -Notifications en temps réel(WebSocket) -Chat en temps réel -##Démo +## Démo Une interface de démonstration est disponible ici: https://mallardromain.com/hotel-demo/ -##Installation +## Installation -###Local +### Local ``` cargo run @@ -43,7 +43,7 @@ cargo run -Les bases SQLite sont présentes par défaut dans `/db` -Port par défaut : 7080(configuré dans `main.rs`) -###Docker +### Docker ``` docker run -d \ @@ -55,21 +55,21 @@ Notes: -Il est nécessaire de copier les bases de donner par défaut dans le volume -Le scret doit obligatoirement être préciser a la création du container -Valeur de JWT_SECRET pour les utilisateur présent sur les bases de donnée par défault: -`your_jwt_secret_key` + `your_jwt_secret_key` -##Architecture +## Architecture -###Routing +### Routing -Point d'entrée: `./src/routes/mod.rs` (utilié dans le `./main.rs`) -Organisation par domaine: -chaque module posséde son propre `routes.rs` -###Modules principaux +### Modules principaux -`.src/rooms`,`.src/inventory` et `.src/chat` sont principalement de la logique CRUD -###Utils +### Utils -`src/utils/db_pools.rs` Getsion des connexions aux bases SQLite de chaque hôtels @@ -82,7 +82,7 @@ Notes: -Génération et validation des JWT -Pré-traitement des tokens -##Authentification +## Authentification Flow: @@ -98,7 +98,7 @@ Flow: `/auth/ws/YourToken` -##Ce que j'ai appris +## Ce que j'ai appris -Utilisation du framework "Axum" -Gestion de payload des requète explicite et stricte