Kourtier API
Bienvenue sur la documentation de l'API du projet Kourtier, une plateforme immobilière complète. Cette API RESTful permet de gérer l'ensemble des fonctionnalités nécessaires à une application immobilière moderne.
Architecture du projet
Le backend est structuré selon le modèle MVC :
- Controllers : Contiennent la logique métier pour chaque entité
- Routes : Définissent les points d'accès API
- Models : Définis dans le fichier schema.prisma
- Lib : Contient le client Prisma partagé
Fonctionnalités principales
- Gestion des propriétés immobilières : différents types de biens (maisons, appartements, terrains, bureaux, commerces, hôtels, etc.)
- Gestion des utilisateurs : clients, propriétaires, administrateurs
- Système de rendez-vous : pour visiter les propriétés
- Favoris : marquer des propriétés comme favorites
- Notifications : envoi de notifications aux utilisateurs
- Gestion des médias : images et vidéos liées aux propriétés
Premiers pas
Pour commencer à utiliser l'API Kourtier, consultez la documentation des différents modules dans la barre latérale. Chaque module contient des instructions détaillées sur les endpoints disponibles et leur utilisation.
Technologies utilisées
- Backend: Node.js avec Express.js
- Base de données: PostgreSQL via Prisma ORM
- Authentification: JWT (JSON Web Tokens)
- Documentation: Documentation HTML personnalisée