Skip to content

🎒 School Project - Redis Notes Simulation Project

License

Notifications You must be signed in to change notification settings

EPSIBordeaux/notes-backend-redis

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

notes-backend-redis

CircleCI License: MIT GitHub release codecov

TP Redis de simulation de serveur de prise de notes

Install it

npm install

Run it

npm start

Test it

npm test

Lint it

This project use StandardJS as linter with a pre-commit hook.

To configure text editor, see this link.

To run linter : npm run lint

To run linter with auto-fix : npm run lint:fix

Demonstration

npm start
./test.sh # In a separate terminal

Explications

Architecture

Un serveur Express répond au requêtes clientes, sur 5 routes différentes :

  • '/notes' en POST, qui permet la création d'une note en text/plain

  • '/notes-details' en POST, qui permet la création d'une note en passant des données au format application/json, ce qui permet de rajouter en plus le champ auteur.

  • '/note/:id' en GET, qui permet de récupérer une note selon son identifiant

  • '/notes' en GET, qui renvoie toutes les notes existantes.

  • '/notes/:id' en DELETE, qui permet de supprimer une note donnée.

Un exemple d'utilisation du système est disponible dans le script test.sh