147 lines
5.6 KiB
Markdown
147 lines
5.6 KiB
Markdown
|
||
|
||
# 📖 Kalulu — Apprends à lire intelligemment
|
||
|
||
## Version Web Docker autonome — Joy
|
||
|
||
Cette variante déploie Kalulu en français sur `https://kalulu.agendx.ch` avec un profil local **Joy**, 5 ans, niveau débutant (Grande Section). Elle n’utilise pas l’API officielle de Kalulu : le pack `fr_FR` est servi par la même image et la progression reste dans le stockage IndexedDB du navigateur.
|
||
|
||
Prérequis : Docker avec BuildKit, un réseau Docker externe `traefik_proxy` et un Traefik fournissant HTTPS.
|
||
|
||
```bash
|
||
docker network inspect traefik_proxy >/dev/null 2>&1 || docker network create traefik_proxy
|
||
docker compose build kalulu
|
||
docker compose up -d kalulu
|
||
./scripts/verify-live.sh
|
||
```
|
||
|
||
Le premier lancement charge environ 45 Mo d’application compressée puis télécharge 66 Mo de contenu pédagogique depuis la même origine. Le pack est extrait directement sur le thread Web principal, par lots, puis conservé localement. L’extraction testée atteint le premier jardin en moins d’une minute, contre plus de huit minutes avec l’extracteur multithread d’origine ; le téléchargement dépend naturellement de la connexion. Effacer les données du site dans le navigateur réinitialise le profil et la progression.
|
||
|
||
L’image construit l’export avec Godot 4.6.3, les modèles d’export officiels et Godot-SQLite 4.8 (la version compilée pour Godot 4.6.3). Nginx sert WebAssembly avec les en-têtes COOP/COEP requis pour les threads.
|
||
|
||
## 🌍 Langues disponibles
|
||
|
||
- 🇬🇧 [English](README.md)
|
||
- 🇪🇸 [Español](README.es.md)
|
||
- 🇧🇷 [Português (Brasil)](README.pt-br.md)
|
||
|
||
---
|
||
|
||
## 📚 Contenu
|
||
|
||
- [🧠 Pourquoi Kalulu ?](#pourquoi-kalulu-)
|
||
- [✨ Fonctionnalités](#fonctionnalités)
|
||
- [🚀 Commencer](#commencer)
|
||
- [1. Cloner le dépôt](#1-cloner-le-dépôt)
|
||
- [2. Installer Godot Engine](#2-installer-godot-engine)
|
||
- [🧩 Addons intégrés](#-addons-intégrés)
|
||
- [🤝 Envie d'aider ?](#-envie-daider-)
|
||
- [❓ FAQ](#faq)
|
||
|
||
---
|
||
|
||
## 🧠 Pourquoi Kalulu ?
|
||
|
||
**Kalulu** est plus qu’un jeu — c’est une aventure éducative fondée sur la recherche scientifique qui aide les enfants à apprendre à lire grâce à la méthode de décodage.
|
||
|
||
Chaque leçon suit une séquence structurée basée sur des données linguistiques issues de la littérature jeunesse. Les enfants commencent par les voyelles, puis progressent vers des sons plus complexes.
|
||
|
||
- 🎯 **Objectif** : Rendre l'apprentissage de la lecture amusant et efficace
|
||
- 🌟 **Basé sur la science** : Développé grâce aux recherches en éducation et en neurosciences
|
||
- 👶 **Public cible** : Enfants, mais utile à tous ceux qui veulent apprendre à lire
|
||
- 🔎 **Recherches publiées** : Plusieurs articles ont été publiés sur la conception de Kalulu et les résultats en lecture, à lire ici :
|
||
https://www.tandfonline.com/doi/pdf/10.1080/00220973.2023.2173129
|
||
https://hal.science/hal-03015914/document
|
||
https://hal.science/hal-03702075/document
|
||
|
||
---
|
||
|
||
## ✨ Fonctionnalités
|
||
|
||
- Leçons interactives de lecture graphème-phonème
|
||
- Progression adaptative de la difficulté
|
||
- Interface adaptée aux enfants avec des visuels attrayants
|
||
|
||
---
|
||
|
||
## 🚀 Commencer
|
||
|
||
### 1. 📥 Cloner le dépôt
|
||
|
||
```bash
|
||
# Clonez votre fork du dépôt
|
||
git clone https://github.com/VOTRE_UTILISATEUR/Kalulu-Frontend.git
|
||
# Ou
|
||
git clone git@github.com:YOUR_USERNAME/Kalulu-Frontend.git
|
||
|
||
cd Kalulu-Frontend
|
||
```
|
||
|
||
🔁 _Remplacez `VOTRE_UTILISATEUR` par votre nom d'utilisateur GitHub._
|
||
|
||
---
|
||
|
||
### 2. 🎮 Installer Godot Engine
|
||
|
||
- Téléchargez depuis [godotengine.org](https://godotengine.org/)
|
||
- Choisissez votre système d’exploitation et lancez l’éditeur
|
||
|
||
---
|
||
|
||
## 🧩 Addons intégrés
|
||
|
||
- 🔄 **EnvironmentSwitcher** – Basculer facilement entre les environnements dev/prod
|
||
- 📤 **export_tool_manager** – Gère les exports multi-plateformes
|
||
- ✅ **godot-form-validator** – Plugin Godot 4 pour valider les éléments d’interface
|
||
- 🗃️ **godot-sqlite** – Intégration SQLite
|
||
|
||
> ⚠️ Téléchargez `godot-sqlite` manuellement depuis l’AssetLib.
|
||
|
||
---
|
||
|
||
## 🤝 Envie d'aider ?
|
||
|
||
Toute aide est la bienvenue !
|
||
|
||
1. **Configurer le projet**
|
||
Consultez la [section Commencer](#commencer) pour apprendre à forker et cloner le dépôt.
|
||
|
||
2. **Créer une nouvelle branche**
|
||
```bash
|
||
git checkout -b feature/nom-de-votre-fonctionnalite
|
||
```
|
||
|
||
3. **Apporter vos modifications**
|
||
Implémentez vos améliorations ou corrections.
|
||
|
||
4. **Valider et pousser les changements**
|
||
```bash
|
||
git add .
|
||
git commit -m "Décrivez vos modifications"
|
||
git push origin feature/nom-de-votre-fonctionnalite
|
||
```
|
||
|
||
5. **Ouvrir une Pull Request**
|
||
Allez sur votre dépôt forké sur GitHub et cliquez sur **Compare & pull request** pour soumettre vos changements.
|
||
|
||
Veuillez vous assurer que votre code respecte nos conventions de codage et inclut les tests ou mises à jour de documentation pertinents lorsque cela est nécessaire.
|
||
|
||
---
|
||
|
||
## ❓ FAQ
|
||
|
||
### 📱 Kalulu est-il disponible sur mobile ?
|
||
|
||
Oui ! Kalulu est disponible pour :
|
||
|
||
- [](https://play.google.com/store/apps/details?id=org.godotengine.kalulu)
|
||
- [](https://apps.apple.com/fr/app/kalulu-education/id1639075967)
|
||
|
||
### 💻 Kalulu est-il disponible sur ordinateur ?
|
||
|
||
Oui ! Des versions pour Windows, Mac et Linux sont disponibles dans la section [Releases](https://github.com/Excello-Recherche-Education/Kalulu-Frontend/releases).
|
||
|
||
### 🌐 Kalulu est-il disponible directement sur le web ?
|
||
|
||
Oui, cette variante autonome est disponible sur [kalulu.agendx.ch](https://kalulu.agendx.ch).
|