Guide de démarrage rapide

Ce guide vous permet de démarrer rapidement avec OC Lettings en 5 minutes.

Installation rapide

# 1. Cloner le projet
git clone https://github.com/C-eorl/Python-OC-Lettings-FR.git
cd Python-OC-Lettings-FR

# 2. Créer et activer l'environnement virtuel
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# 3. Installer les dépendances
pip install -r requirements.txt

# 4. Configurer la base de données
python manage.py migrate

# 5. Lancer le serveur
python manage.py runserver

Accéder à l’application

Page d’accueil

Liste des locations

Liste des profils

Interface d’administration

Note

Pour accéder à l’admin, un superutilisateur est mis a disposition:

utilisateur: admin, mot de passe : Abc1234!

Commandes essentielles

Développement

# Lancer le serveur de développement
python manage.py runserver

# Créer des migrations après modification des modèles
python manage.py makemigrations

# Appliquer les migrations
python manage.py migrate

# Créer un superutilisateur
python manage.py createsuperuser

# Collecter les fichiers statiques
python manage.py collectstatic

Tests et qualité

# Exécuter tous les tests
pytest

# Vérifier le linting
flake8

Docker

# Construire l'image (être à la racine du projet)
docker build -f docker/Dockerfile -t oc-lettings:local .

# Lancer le conteneur
docker run -p 8000:8000 oc-lettings:local

# Récupérer depuis Docker Hub et execute l'image
 docker run -p 8000:8000 ceorl/oc_lettings:latest

Structure du projet

Python-OC-Lettings-FR/
├── doc/                      # Documentation Sphinx
├── lettings/                 # App Django - Locations
│   ├── migrations/
│   ├── templates/lettings/
│   ├── tests/
│   ├── admin.py
│   ├── models.py
│   ├── urls.py
│   ├── apps.py
│   └── views.py
├── profiles/                 # App Django - Profils
│   ├── migrations/
│   ├── templates/profiles/
│   ├── tests/
│   ├── admin.py
│   ├── models.py
│   ├── urls.py
│   ├── views.py
│   └── apps.py
├── oc_lettings_site/         # Configuration Django
│   ├── migrations/
│   ├── apps.py
│   ├── asgi.py
│   ├── tests.py
│   ├── views.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── oc-lettings-site.sqlite3  # Base de donnée Sqlite3
├── static/                   # Fichiers statiques (CSS, JS, images)
├── templates/                # Templates HTML globaux
├── .github/workflows/        # CI/CD GitHub Actions
├── docker/                   # Fichier docker
├── requirements.txt
├── setup.cfg                 # Configuration flake8, etc
└── manage.py

Applications Django

L’architecture est modulaire avec 3 applications :

oc_lettings_site

Application principale contenant :

  • Configuration Django (settings.py)

  • Routing principal (urls.py)

  • Page d’accueil

lettings

Gestion des locations immobilières :

  • Modèles : Address, Letting

  • URL : /lettings/

  • Templates dans lettings/templates/lettings/

profiles

Gestion des profils utilisateurs :

  • Modèle : Profile

  • URL : /profiles/

  • Templates dans profiles/templates/profiles/

Prochaines étapes