Installation
Cette section décrit les étapes nécessaires pour installer et configurer OC Lettings en environnement de développement local.
Prérequis système
Logiciels requis
Python 3.10 ou supérieur
Git
Récupération du code source
Cloner le dépôt Git
git clone https://github.com/C-eorl/Python-OC-Lettings-FR.git
cd Python-OC-Lettings-FR
Configuration de l’environnement
Créer un environnement virtuel
python -m venv venv
Activer l’environnement virtuel
# Linux / Mac
source venv/bin/activate
# Windows
venv\Scripts\activate.bat
Installer les dépendances
# Installer toutes les dépendances du projet
pip install -r requirements.txt
Configuration de la base de données
Appliquer les migrations
# Créer les tables de la base de données
python manage.py migrate
Créer un superutilisateur (optionnel)
Pour accéder à l’interface d’administration : Soit vous utilisez le superuser déjà créé: admin - Abc1234!
Soit vous en créez un :
python manage.py createsuperuser
# Suivre les instructions interactives :
# - Username: admin
# - Email: admin@example.com
# - Password: (votre mot de passe sécurisé)
Variables d’environnement
Créer un fichier .env
À la racine du projet, créer un fichier .env :
# .env
SECRET_KEY=votre-clé-secrète-django-très-longue-et-aléatoire
DEBUG=True
ALLOWED_HOSTS=localhost,127.0.0.1
SENTRY_DSN=https://votre-dsn-sentry@sentry.io/projet-id
Avertissement
Ne jamais committer le fichier .env dans Git.
Ajouter .env dans .gitignore.
Vérification de l’installation
Lancer le serveur de développement
python manage.py runserver
Ouvrir un navigateur et accéder à :
Vous devriez voir la page d’accueil d’OC Lettings.
Vérifier l’interface admin
Accéder à :
Se connecter avec le superutilisateur créé précédemment.
Exécuter les tests
# Exécuter tous les tests
pytest
Vérifier le linting
# Vérifier la conformité PEP 8
flake8
Note
Tous les tests doivent passer et le linting ne doit signaler aucune erreur.
Étapes suivantes
Une fois l’installation terminée, consulter :
Guide de démarrage rapide pour un guide de démarrage rapide
Guide d’utilisation pour apprendre à utiliser l’application
Procédures de déploiement pour déployer en production