Update README
This commit is contained in:
34
README.md
Normal file
34
README.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
<h1 align=center>Blog API</h1>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="#prerequis"><img src="https://img.shields.io/badge/Prerequis-000fff.svg" alt="Prérequis"></a>
|
||||||
|
<a href="#installation"><img src="https://img.shields.io/badge/Installation-000ff.svg" alt="Installation"></a>
|
||||||
|
<a href="#usage"><img src="https://img.shields.io/badge/Usage-f00.svg" alt="Usage"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## 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
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user