OpenClassrooms Projet P10

• Objectif
• Compétences
• Technologies
• Requirements
• Architecture
• Configuration locale
• Documentation
• Présentation

Objectif

SoftDesk, une société d'édition de logiciels de développement et de collaboration, a décidé de publier une application permettant de remonter et suivre des problèmes techniques (issue tracking system). Cette solution s’adresse à des entreprises clientes, en B2B. L'objectif du projet est de créer un back-end performant et sécurisé (API sécurisée RESTful en utilisant Django REST), devant servir les applications sur toutes les plateformes.

Compétences acquises

• Documenter une application
• Créer une API RESTful avec Django REST
• Sécuriser une API afin qu'elle respecte les normes OWASP et RGPD

Technologies Utilisées

• Python3
• Django
• DjangoRestFramework
• JWT
• Sqlite

Requirements

• django
• djangorestframework
• djangorestframework-simplejwt
• python-dotenv

Architecture et répertoires

Project
├── softdesk
│   ├── api
│   ├── core : répertoire contenant notre application principale
│   │    ├── comments
│   │    ├── contributors
│   │    ├── issues
│   │    ├── projects
│   │    ├── users
│   ├── softdesk : répertoire du projet django
│   │    ├── settings.py : fichier de réglages django
│   │    ├── urls.py : fichier principal des endpoints
│   │    ├── ..
│   ├── db.sqlite3 : base de données
│   ├── manage.py : fichier principal de gestion django
│
|── requirements.txt
|── documentation
|── postman

Configuration locale

Installation

1. Récupération du projet sur votre machine locale

Clonez le repository sur votre machine.

git clone https://github.com/GDSDC/OpenclassroomsProject-P10.git

Accédez au répertoire cloné.

cd OpenclassroomsProject-P10

2. Création d'un environnement virtuel

Créez l'environnement virtuel env.

python3 -m venv env

3. Activation et installation de votre environnement virtuel

Activez votre environnement virtuel env nouvellement créé.

source env/bin/activate

Installez les paquets présents dans la liste requirements.txt.

pip install -r requirements.txt

4. Initialisation de la base de données

Accédez au dossier de travail.

cd softdesk

Procédez à une recherche de migrations.

python manage.py makemigrations

Lancer les migrations nécessaires.

python manage.py migrate

Utilisation

1. Démarrage du serveur local

Accédez au dossier de travail.

cd softdesk

Démarrez le serveur local.

python manage.py runserver

Documentation

Retrouvez la documentation de l'api sur postman : https://documenter.getpostman.com/view/11247386/VUqyoZZ5

Présentation