An open API service indexing awesome lists of open source software.

https://github.com/florianmgs/oc-p10-softdesk

OpenClassrooms - Python Application Developer - Project 10
https://github.com/florianmgs/oc-p10-softdesk

django django-permissions django-rest-framework owasp postman

Last synced: 3 months ago
JSON representation

OpenClassrooms - Python Application Developer - Project 10

Awesome Lists containing this project

README

        

# OC_P10_SoftDesk
Projet réalisé dans le cadre de ma formation OpenClassrooms Développeur d'Applications Python.
Il s'agit d'une API réalisée avec Django pour une société fictive, SoftDesk.
L'application permet de remonter et suivre des problèmes techniques (issue tracking system).

## Features

Tout les endpoints, leurs détails ainsi que des exemples d'utilisation sont décrits dans la [documentation](https://documenter.getpostman.com/view/18605508/UVRBkkQX).

## Installation & lancement

Commencez tout d'abord par installer Python.
Lancez ensuite la console, placez vous dans le dossier de votre choix puis clonez ce repository:
```
git clone https://github.com/FlorianMgs/OC_P10_SoftDesk.git
```
Placez vous dans le dossier OC_P10_SoftDesk, puis créez un nouvel environnement virtuel:
```
python -m venv env
```
Ensuite, activez-le.
Windows:
```
env\scripts\activate.bat
```
Linux:
```
source env/bin/activate
```
Installez ensuite les packages requis:
```
pip install -r requirements.txt
```
Ensuite, placez vous à la racine du projet (là ou se trouve le fichier manage.py), puis effectuez les migrations:
```
python manage.py makemigrations
```
Puis:
```
python manage.py migrate
```
Il ne vous reste plus qu'à lancer le serveur:
```
python manage.py runserver
```
Vous pouvez ensuite utiliser l'applicaton via les différents endpoints décrits dans la documentation.
Vous devez d'abord créer un compte utilisateur à l'endpoint http://127.0.0.1:800/api/signup/ afin d'accéder aux fonctionnalités de l'application.