GalsenAPi

📋 Table des matières

• Aperçu
• Installation
• Utilisation
• Fonctionnalités
• Technologies
• Auteur
• Remerciements

🚀 Aperçu

GalsenApi est une API REST qui vous permet d'accéder facilement aux données du Sénégal. Ce projet s'inspire du package Galsenify et fournit des informations détaillées sur :

• Les régions du Sénégal
• Les départements
• Les arrondissements
• Les communes
• Les villages
• Les Universités et Ecole de formations
• Les données démographiques
• Et plus encore...

⚙️ Installation

1. Créez un environnement virtuel :

python -m venv .venv

2. Activez l'environnement virtuel :

source .venv/bin/activate

3. Installez les dépendances :

pip install -r requirements.txt

4. Effectuez les migrations :

python manage.py makemigrations
python manage.py migrate

5. Créez un super utilisateur :

python manage.py createsuperuser

6. Créez un fichier .env dans le projet Django pour stocker la clé secrète.

🎯 Utilisation

Points d'accès de l'API

Récupérer toutes les régions

GET /api/regions/

Récupérer une seule région

GET /api/regions/1/

Récupérer tous les départements

GET /api/departements

Récupérer un seul département

GET /api/departements/1/

Récupérer tous les arrondissements

GET /api/arrondissements/

Récupérer un seul arrondissement

GET /api/arrondissements/1/

Récupérer toutes les communes

GET /api/communes/

Récupérer une seule commune

GET /api/communes/1/

Récupérer tous les villages

GET api/villages

Récupérer un seul village

GET /api/villages/1

Récupérer tous les Universités et Ecole de formations

GET /api/universites/

Récupérer une universite ou ecole de formation

GET /api/universites/1

Récupérer les informations sur le pays

GET /api/pays/

💫 Fonctionnalités

• ✨ Interface utilisateur moderne et responsive
• 📱 Compatible mobile
• 🔍 Recherche avancée
• 📊 Données détaillées et à jour
• 🔒 Sécurisé et fiable

🛠 Technologies

• 
• 
• 
• 

👤 Auteur

Lassana SIBY

💝 Remerciements

Merci à Daouda BA pour les donées.

Exemple d'utilisation de l'api

Views region et departement

def regions_view(request):
    query = request.GET.get('q')
    url = 'https://galsenapi.vercel.app/api/regions/'
    params = {'search': query} if query else {}
    response = requests.get(url, params=params)
    data = response.json()
    regions = data
    context = {'regions': regions, 'query': query}
    return render(request, 'demo/regions.html', context)


def departments_view(request):
    query = request.GET.get('q')
    url = 'https://galsenapi.vercel.app/api/departements/'
    params = {'search': query} if query else {}
    response = requests.get(url, params=params)
    data = response.json()
    departments = data
    context = {'departments': departments, 'query': query}
    return render(request, 'demo/departements.html', context)

def villages_view(request):
    query = request.GET.get('q')
    url = 'https://galsenapi.vercel.app/api/villages/'
    params = {'search': query} if query else {}
    response = requests.get(url, params=params)
    data = response.json()
    villages = data
    context = {'villages': villages, 'query': query}
    return render(request, 'demo/village.html', context)    

📝 License

Star History