poly4concept/Yoruba-Proverb-Quiz-Service

The Yoruba Proverb Quiz Service is a web application that helps users learn, match, and test their knowledge of Yoruba proverbs and their meanings. Users can match scenarios to proverbs, take interactive quizzes, and receive instant feedback and results. The app leverages AI for proverb matching. # Yoruba Proverb Quiz Service ## Description The Yoruba Proverb Quiz Service is a web application that helps users learn, match, and test their knowledge of Yoruba proverbs and their meanings. Users can match scenarios to proverbs, take interactive quizzes, and receive instant feedback and results. The app leverages AI for proverb matching and provides a modern React-based frontend with a Flask backend. --- ## Table of Contents - Installation - Usage - Features - Configuration - API-Routes - Deployed Services - License --- ## Installation 1. **Clone the repository:** ```sh git clone github.com cd yoruba-proverb-quiz-service ``` 2. **Install Python dependencies:** ```sh pip install -r requirements.txt ``` 3. **Install Node.js dependencies (OPTIONAL):** ```sh npm install ``` 4. **Prepare your data:** - Ensure `processed_data.csv`-which contains Povebs, Tanslation, Wisdom and Scenarios and `All provebs.csv` which should contain Simila fields (Scenario is optional here) are present in the root directory. 5. **Set up environment variables (if needed):** - For Google Gemini API and ChromaDB, configure your API keys as required. **`GOOGLE_API_KEY`, `AI...`** can be gotten from GoogleAI studio --- ## Usage 1. **Start the Flask backend:** ```sh python app.py ``` 2. **Access the app:** - Open your browser and go to `localhost` 3. **Frontend:** - The React app is loaded via CDN in `templates/index.html`. - No separate build step is required unless you want to customize the frontend. --- ## Features - **Scenario to Proverb Matching:** Enter a scenario and get relevant Yoruba proverbs using AI. - **Interactive Quiz:** Take quizzes with customizable question count and type. - **Instant Feedback:** Get immediate feedback and explanations for each answer. - **Result Download:** Download your quiz results as a CSV file. - **Daily Proverb:** Get a random Yoruba proverb, translation, and wisdom each day. …