🏫 SmartSchool ERP — Système de Gestion Scolaire Intégré
Client : Gouvernement de Guinée
Stack : FastAPI (Python) + Next.js 16 (React/TypeScript) + PostgreSQL
Deadline : 15 Juillet 2026
📁 Structure du Projet
SMART_SCHOOL_FINAL/
├── backend/ # API FastAPI (Python)
│ ├── app/
│ │ ├── api/ # Endpoints (eleves, enseignants, finance, etc.)
│ │ ├── core/ # Auth, sécurité, config base de données
│ │ ├── models/ # Modèles SQLAlchemy (ORM)
│ │ └── schemas/ # Schémas Pydantic (validation)
│ └── main.py # Point d'entrée du serveur
│
├── frontend/ # Application Next.js (TypeScript)
│ └── src/
│ ├── app/ # Pages (dashboard, eleves, comptabilite, portails...)
│ ├── components/ # Composants réutilisables (Sidebar, Topbar...)
│ ├── context/ # Contextes React (Auth, App)
│ └── lib/ # Utilitaires (api.ts)
│
├── database/ # Scripts SQL (structure, données de démo)
├── docs/ # Documentation du projet
│ ├── audit/ # Audits de sécurité et plans de travail
│ ├── comptabilite/ # Cahier des charges et suivi du module comptabilité
│ ├── guides/ # Guides d'équipe (GitHub workflow, commandes)
│ └── pedagogie/ # Programmes scolaires guinéens et système de notation
│
├── scripts/ # Scripts utilitaires (migrations, corrections)
├── secrets/ # Mots de passe locaux (⚠️ EXCLUS de Git)
│
├── docker-compose.yml # Orchestration Docker
├── START.bat # Lancement rapide Windows
├── STOP.bat # Arrêt rapide Windows
└── .gitignore # Fichiers exclus du dépôt
🚀 Installation Rapide
Prérequis
- Node.js (v18+) et npm
- Python (v3.10+) et pip
- PostgreSQL (v14+)
1. Cloner le projet
git clone https://github.com/Iya2006/SmartSchool_Final-PROD.git
cd SmartSchool_Final-PROD
2. Configurer le backend
cd backend
pip install -r requirements.txt
cp ../.env.example .env
# Éditer .env : renseigner vos propres identifiants PostgreSQL et un JWT_SECRET_KEY
# (créez d'abord une base Postgres vide, ex: createdb mydb)
uvicorn main:app --reload --port 8500
Le schéma de la base (toutes les tables) se crée automatiquement au
premier démarrage (Base.metadata.create_all dans main.py) — aucun script
SQL à lancer à la main. database/install.sql et les scripts numérotés sont
des reliquats d'une ancienne version Oracle du projet, ils ne s'appliquent
plus à ce backend (Postgres) : à ignorer.
3. Peupler avec des données de démonstration (recommandé)
python seed_db.py
Une base fraîchement créée est vide (aucun élève, aucune classe) — ce script
crée un établissement, des classes et des élèves de test pour pouvoir
naviguer dans l'application (idempotent, sans risque à relancer). D'autres
scripts de seed existent (seed_referentiels.py, seed_classes_guinee.py)
pour enrichir davantage (trimestres, programme guinéen complet) — à exécuter
après seed_db.py, en vérifiant leur contenu avant lancement (l'un d'eux
contient un chemin codé en dur à adapter).
3. Configurer le frontend
cd frontend
npm install
npm run dev
4. Accéder à l'application
🌿 Workflow Git (Pour l'équipe)
Voir le guide complet : docs/guides/github_workflow_guide.md
En résumé :
git checkout develop → Se placer sur la branche d'intégrationgit pull origin develop → Récupérer les dernières mises à jourgit checkout -b feature/ma-tache → Créer sa branche personnelle- Coder, tester,
git add ., git commit -m "...", git push origin feature/ma-tache
- Créer une Pull Request sur GitHub de
feature/... vers develop
📋 Répartition des Tâches
Voir : docs/comptabilite/repartition_taches_comptabilite.md
⚠️ Règles Importantes
- NE JAMAIS coder directement sur
main ou develop.
- NE JAMAIS pousser le dossier
secrets/ ou les fichiers .env sur GitHub.
- TOUJOURS créer une branche
feature/... pour chaque tâche.
- COMMUNIQUER sur le groupe avant de modifier un fichier partagé.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
