diff --git a/README.md b/README.md index 842f77c..68a56a9 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,54 @@ -# Prénoms de France 🇫🇷 +# Prénoms stats -Application web d'exploration des prénoms INSEE. +Application web d'exploration des prénoms français, basée sur les données INSEE. ## Démarrage rapide 1. **Placez le fichier INSEE** dans le dossier `data/` : - ``` + ```bash mkdir -p data - cp prenoms.csv data/ + cp prenoms-2024-nat.csv data/prenoms.csv ``` + > Téléchargeable sur [insee.fr](https://www.insee.fr/fr/statistiques/7633685) — fichier "Prénoms par année de naissance" 2. **Lancez l'application** : ```bash - docker compose up --build + docker compose up -d ``` -3. **Ouvrez** [http://localhost:8080](http://localhost:8080) +3. **Ouvrez** [http://localhost:8070](http://localhost:8070) ## Fonctionnalités -- 📈 **Graphique d'évolution** : cliquez sur un prénom pour voir ses naissances par année -- 🔍 **Recherche filtrée** : par début de prénom, genre, longueur, popularité, période -- 🏆 **Top prénoms** récents (2010–2023) -- 📊 **Statistiques globales** : total de naissances, nombre de prénoms, période couverte - -## Format du fichier INSEE - -``` -sexe;prenom;periode;valeur -1;AABAN;2018;5 -``` - -- `sexe` : 1 = Masculin, 2 = Féminin -- `prenom` : en majuscules (les prénoms rares `_PRENOMS_RARES` sont filtrés) -- `periode` : année -- `valeur` : nombre de naissances +- 🔍 **Explorer** — graphique d'évolution, carte de chaleur par décennie, statistiques, tendance, comparaison de deux prénoms, partage par URL +- ✨ **Trouver** — recherche filtrée par genre, popularité, longueur, initiale, période +- 🏆 **Classement** — tous les prénoms triés par nombre de naissances, paginés, filtrables ## Structure ``` prenoms-app/ -├── backend/ # FastAPI + Pandas -├── frontend/ # HTML/JS + Nginx -├── data/ # Montez prenoms.csv ici +├── data/ # Placez prenoms.csv ici (non versionné) +├── main.py # Backend FastAPI + Pandas +├── index.html # Frontend HTML/JS/CSS (fichier unique) +├── nginx.conf # Reverse proxy vers le backend └── docker-compose.yml ``` + +## Stack technique + +- **Backend** : FastAPI + Pandas + Uvicorn (Python 3.11) +- **Frontend** : HTML/CSS/JS vanilla + Chart.js +- **Infrastructure** : Docker Compose, Nginx + +## Format du fichier INSEE + +``` +sexe;prenom;periode;valeur +1;GABRIEL;2023;5285 +``` + +- `sexe` : 1 = Masculin, 2 = Féminin +- `prenom` : en majuscules (`_PRENOMS_RARES` est filtré automatiquement) +- `periode` : année de naissance +- `valeur` : nombre de naissances (arrondi par multiples de 5 par l'INSEE)