🇧🇮 Ijwi ry'Ikirundi AI: Contribution Hub

A web application for collecting Kirundi language contributions to help build AI language models

📖 Overview

The Ijwi ry'Ikirundi AI Contribution Hub helps crowdsource Kirundi language data for AI model training. Community members can contribute translations and sentence pairs to preserve and advance the Kirundi language.

🎯 Easy Level: Kirundi to French Translation

• Translate existing Kirundi phrases to French
• AI-powered suggestions: Get machine translation suggestions to approve or edit
• Smart workflow: Approve suggestions with one click or edit manually
• Live data from Hugging Face dataset
• Progress tracking with localStorage
• Downloads as Kirundi_To_French.csv
• Report/correct Kirundi phrases: Users can flag and suggest corrections for Kirundi sentences
• Error and completion messages are always mutually exclusive (never both visible)
• All error messages default to English

🔄 Medium Level: French to Kirundi Translation

• Translate French sentences to Kirundi
• Duplicate checking against existing database
• Downloads as French_To_Kirundi.csv
• Error and completion messages are always mutually exclusive

✍🏾 Hard Level: Add New Sentences

• Create original Kirundi-French sentence pairs
• Input validation (both fields required, minimum 4 words recommended)
• Duplicate checking: prevents submission of Kirundi sentences already in the database

All levels include:

• 🌙 Dark mode toggle: Switch between light and dark themes with smooth animations
• 🌐 Language toggle button (FR/EN) for all instructions and feedback
• ⌨️ Keyboard shortcuts (Ctrl+Enter to submit, Escape to skip)
• 📱 Mobile-responsive design with modern UI components
• 🎨 Professional button designs with gradients, shadows, and smooth transitions
• 💾 Auto-save progress to prevent data loss

🚀 Quick Start

Option 1: Direct Use

1. Open index.html in your browser
2. Choose your contribution level
3. Follow on-screen instructions

Option 2: Local Server (Recommended)

cd Kirundi_Game
python -m http.server 8000
# Visit: http://localhost:8000

🛠 Technical Details

• Frontend: HTML5, CSS3, Vanilla JavaScript
• Styling: Tailwind CSS + Custom CSS (buttons, dark mode)
• Data Source: Live data from Hugging Face
• Storage: Browser localStorage for progress tracking
• Deployment: GitHub Pages compatible
• Backend Script: Google Apps Script
• Central Database: Google Sheets
• Live Demo: Kirundi Contribution App

📁 Project Structure

Kirundi_Game/
├── index.html              # Main application file
├── static/                 # Static assets folder
│   ├── script.js          # Core JavaScript logic
│   ├── styles.css         # Main styles
│   ├── buttons.css        # Button component styles
│   ├── darkmode.css       # Dark mode theme styles
│   └── icon.png           # Application logo
├── french_prompts.txt     # French sentences for Medium mode
├── README.md              # Documentation
└── submissions/           # User contribution storage

🎨 UI Features

• Dark Mode: Smooth theme switching with localStorage persistence
• Responsive Design: Mobile-first approach with Tailwind CSS
• Modern Components: Gradient buttons, smooth animations, professional shadows
• Accessibility: Focus rings, ARIA labels, keyboard navigation
• Gamification Rank Card:
  • Visual progression tracking with emoji-based rank system (🌱 → 👑 → 🦁)
  • Real-time contribution counter with smooth progress bar
  • Next rank milestone indicator with contributions remaining
  • Mobile-optimized layout: Displays "Your Rank" and "Next Rank" stacked vertically on phones
  • Color-coded progress bar (Yellow → Orange → Red) showing advancement
  • High-visibility percentage display with drop shadow effect
  • Responsive design: Full-width boxes on mobile, side-by-side on desktop

💾 Data Format

All CSV files use standardized headers:

Easy Level (Kirundi → French)

Original_Kirundi,Corrected_Kirundi,French_Translation
"Muraho, amakuru?","Muraho, amakuru?","Bonjour, comment allez-vous?"

Medium Level (French → Kirundi)

Kirundi_Transcription,French_Translation
"Ndagukunda cane.","Je t'aime beaucoup."

Hard Level (New Sentences)

Kirundi_Transcription,French_Translation
"Ndagukunda cane.","Je t'aime beaucoup."

All downloads and submissions use these formats to ensure compatibility with the central dataset.

🫱🏽‍🫲🏿 Contributing

Contact: 📱 WhatsApp +257 77 568 903
Team: Ijwi Ry'Ikirundi AI Team

❓ Troubleshooting & FAQ

• Q: What is the Gamification Rank Card?

  • A: The rank card displays your contribution progress with a visual ranking system. It shows your current rank (🌱 Beginner → 👑 Master → 🦁 Legend), total contributions, the next rank you can achieve, and how many more contributions are needed. The progress bar provides a visual indication of your advancement.

• Q: Why does the percentage in the progress bar look cut off on my phone?

  • A: The percentage should now be clearly visible with a dark text color and drop shadow effect in light mode. Try refreshing your browser (Ctrl+Shift+R) or clearing your cache if it still appears unclear.

• Q: Why do I see both an error and a congratulations/completion message at the same time?

  • A: This should never happen. The app now ensures only one is visible at a time. If you see both, try a hard refresh (Ctrl+Shift+R) or clear your browser cache.

• Q: How can I report a problem with a Kirundi phrase?

  • A: In Easy Level, click the "Report a problem" button below the Kirundi phrase to submit a correction or flag an issue.

• Q: How do I enable dark mode?

  • A: Click the circular button in the top-right corner (next to the language toggle). The moon icon switches to dark mode, and the sun icon switches back to light mode. Your preference is saved automatically.

• Q: What are AI suggestions in Easy Mode?

  • A: When available, the app shows machine-generated French translations for Kirundi phrases. You can approve them with one click or edit them manually if needed.

📞 Support

For questions, feedback, or technical support:

• 💬 WhatsApp: +257 77 568 903
• 📧 Email: Junior_julescesar10@hotmail.com

---

🇧🇮 Preserving Heritage • Building Future • Empowering Community 🇧🇮

© 2026 Ijwi Ry'Ikirundi AI Team

This app is ready for deployment on GitHub Pages or any static hosting service. Simply upload all files to your web server or GitHub repository.