Skip to content

Pauller13/backend-test-devolution

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API REST ACTIONELLE

DESCRIPTION

API REST ACTIONELLE est un projet est le backend d'une application d'assurance automobile, développé avec Django. Il fournit une API REST pour gérer principalement les simulations et les souscriptions.
Il permet aussi de gérer des utilisateurs

PREREQUIS

Python 3.10 ou 3.11, Un editeur de code, PostgreSQL et Postman Docker

Installation

1.Cloner le repository et ouvrez le dossier Cloner le repository dans un dossier souhaité avec la commande git clone https://github.com/Pauller13/backend-test-devolution.git et ouvrez le dossier avec la commande cd backend-test-devolution

2.Créer un environnement virtuelle
python -m venv venv sur windows ou python3 -m venv venv sur linux ou macOs
3.Activez l'environnement virtuelle
venv\Scripts\activate sur windows ou source venv/Scripts/activate sur git bash ou source venv/bin/activate sur linux et macOs
4.télechargez les modules nécessaires avec la commande pip install -r requirements ou pip3 install - requirements.txt

5. Entrez dans le dossier src avec la commande cd src

6. Créez votre bd nommée actionElles_db dans PostgreSQL et remplacez vos infos de connexion par ceux qui sont dans la section DATABASES du setting.py ou montainer le container de la db grace au fichier de configuration postgres.yml dans le dossier docker

7. Lancez votre serveur avec la commande python manage.py runserver

Documentation de l'API

La documentation de l'API est générée avec Swagger. Visitez api/v1/swagger/ après le lancement du serveur pour accéder à la documentation.

Choix Techniques

Utilisation de Django REST Framework pour une gestion simplifiée des API.
Architecture en couche pour séparer les préoccupation

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages