diff --git a/README.md b/README.md new file mode 100644 index 0000000..28cdf9a --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +

Blog API

+ +

+Prérequis +Installation +Usage +

+ +## Prérequis +Pour exécuter ce projet vous devez avoir : +- Docker +- Docker Compose +- Make + +## Installation +Pour installer le projet, il faut d'abord cloner le repo, puis lancer les conteneurs : + +```bash +make run +``` + +Il vous faudra ensuite modifier le fichier `.env` pour y mettre les credentials de la base de données, telles qu'elles sont décrites dans `images/.env`. + +## Usage + +Pour utiliser l'API, vous pouvez utiliser un client HTTP comme Postman ou Insomnia. + +Cependant, pour simplifier les requêtes vous pouvez utiliser le swagger mis à disposition à l'adresse suivante : + +```plaintext +http://localhost:8000/api/docs +// ou en production +https://isi2.ale-pri.com/swagger +``` \ No newline at end of file