README.md

Site internet d'OSER - Backend

Bienvenue ! Ce dépôt est le lieu de développement du backend du site internet de l'association OSER, site qui a pour objectif de soutenir l'association dans son action quotidienne.

Si vous venez d'arriver, vous trouverez ci-dessous les ressources pour bien démarrer.

Happy coding !

Table des matières

• Installation
• Guides et documentation
• Déploiement
• Dépendances principales
• À propos d'OSER

Installation

Cette section vous explique comment installer le site sur votre ordinateur pour le faire tourner en mode développement.

Logiciels

Python

Le backend d'OSER est développé avec Django, un framework web Python. Le site nécessite Python 3.5+.

Télécharger Python 3.5+

PostgreSQL

Le site utilise une base de données SQL. Plusieurs technologies existent mais on utilise ici PostgreSQL qu'il vous faut donc installer (choisissez l'installateur selon votre OS).

Télécharger PostgreSQL

Après avoir installé PostgreSQL, démarrez le serveur en ouvrant pgAdmin, l'interface graphique qui sera installée en même temps que Postgres.

Installation du projet

• (Recommandé) Créez un environnement virtuel (ici appelé env) puis activez-le :

$ python -m venv env
$ source env/bin/activate

• Installez les dépendances :

$ pip install -r requirements.txt

• Configurez la base de données en exécutant les migrations (rappelez-vous : le serveur PostgreSQL doit être actif) :

$ python manage.py migrate

Il ne vous reste plus qu'à lancer le serveur de développement :

$ python manage.py runserver

Celui-ci sera accessible à l'adresse http://localhost:8000.

Guides et documentation

Accéder à l'administration

L'interface d'administration du site permet d'effectuer des opérations d'administration (modification de données, réinitialisation de mot de passe, création ou désactivation d'utilisateur…).

En production, utilisez l'administration prudamment et n'y donnez accès qu'à des personnes de confiance et avec les autorisations adéquates !

Lorsque vous accéder au site (par exemple à http://localhost:8000), vous êtes redirigés vers la page d'authentification de l'administration. Authentifiez-vous avec un compte autorisé (compte administrateur ou autre compte auquel le statut staff a été attribué).

En développement, si vous venez d'installer le site, il n'y a pas encore d'utilisateurs dans la BDD. Il vous faut donc créer un compte administrateur. Pour cela, exécutez la commande initadmin :

$ python manage.py initadmin

Les identifiants par défaut sont indiqués dans le fichier settings/common.py. En production, pensez à mettre à jour le mot de passe de ce compte !

Pour des raisons de sécurité, cette commande produira une erreur si des utilisateurs existent déjà dans la base de données. Vous ne pouvez donc l'exécuter que sur une BDD vide.

Documentation de l'API

En développement, vous pouvez accéder à la documentation de l'API à l'adresse http://localhost:8000/api/docs.

Vous pouvez aussi librement parcourir l'API à l'adresse http://localhost:8000/api.