From fe75c3355de209efe0cbea5a8f6afd13d628c293 Mon Sep 17 00:00:00 2001 From: Fara7 Date: Mon, 1 Dec 2025 21:04:48 +0200 Subject: [PATCH 1/5] feat: update readme --- README.md | 92 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 71 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index df337e6..78af180 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,78 @@ -# Qurio +# Qurio -A modern Android trivia quiz application built with **MVP architecture** where users challenge their knowledge across multiple categories, earn points, build daily streaks, and unlock unique characters. +A modern Android trivia quiz application built with MVP architecture to challenge your knowledge, earn points, and unlock rewards! ---- +## Table of Contents +- [Overview](#overview) +- [Features](#features) +- [Screenshots](#screenshots) +- [Tech Stack](#tech-stack) +- [Architecture](#architecture) +- [Setup](#setup) -## ✨ Features -- 🎵 Multiple trivia categories (Music, Food & Drink, Geography, History, and more) -- 🧑‍🎨 Character selection system with unique avatars -- ⭐ Points and rewards system -- 🔥 Daily streak tracking -- 📊 Game history and performance tracking -- ⏱️ Time-based scoring system -- 🎬 Smooth animations and modern UI +## Overview +Qurio is an engaging trivia quiz app for Android that lets users test their knowledge across various categories like Music, Geography, History, and more. With gamification elements such as daily streaks, character unlocks, and a time-based scoring system, it keeps users coming back for daily challenges. Built with a focus on smooth animations and a modern UI, Qurio provides an immersive experience for trivia enthusiasts. ---- +This app is developed as part of the Havana Squad project and uses the Open Trivia Database API for dynamic questions. + +## Features +- ✨ Multiple Trivia Categories: Dive into topics like Music, Food & Drink, Geography, History, and beyond. +- 🧑‍🎨 Character Selection System: Choose and unlock unique avatars to personalize your profile. +- 🏆 Points and Rewards System: Earn points for correct answers and climb the leaderboards. +- 🔥 Daily Streak Tracking: Build and maintain streaks for bonus rewards. +- 📊 Game History and Performance Tracking: Review past quizzes and track your progress over time. +- ⏱️ Time-Based Scoring System: Race against the clock for higher scores. +- 🎨 Smooth Animations and Modern UI: Enjoy fluid transitions and a clean, intuitive design. + +## Screenshots + +| | | | +|:--:|:--:|:--:| +| | | | +| | | | + +[Demo](https://drive.google.com/file/d/1YIb1v9tOz5LbJB7hbO4G_yUnz9R89WZS/view?usp=sharing) + + +## Tech Stack +| Category | Technology | +|----------|------------| +| Language | Kotlin | +| Architecture | MVP (Model-View-Presenter) | +| UI Components | XML Layouts, Fragments, View Binding | +| Navigation | Jetpack Navigation Component | +| Networking | Retrofit | +| Database | Room | +| Dependency Injection | Dagger 2 | +| Async Handling | Kotlin Coroutines | + +## Architecture +MVP drawio (1) + + +| Layer | Responsibility | Key Components | +|-------|----------------|----------------| +| Model | Handles data operations, including API calls and local storage. | Repositories, Data Models, Room DAOs | +| View | Manages UI rendering and user interactions (Activities/Fragments). | XML Views, Adapters, View Binding | +| Presenter | Acts as intermediary: processes inputs from View, fetches data from Model, and updates View. | Presenters for Quiz, Profile, History screens | + +## Setup +To get started with Qurio locally: + +1. **Clone the Repository:** + ```bash + git clone https://github.com/Havana-Squad/Qurio.git + cd Qurio + ``` + +2. **Sync Gradle:** + - Open the project in Android Studio and let Gradle sync. + +**Requirements:** Android Studio (latest), SDK 21+, Gradle 7.0+. -## 🛠 Tech Stack -- **Language:** Kotlin -- **Architecture:** MVP (Model-View-Presenter) -- **UI:** XML Layouts, Fragments, View Binding -- **Navigation:** Jetpack Navigation Component -- **Networking:** Retrofit -- **Database:** Room -- **Dependency Injection:** Dagger 2 -- **API:** https://opentdb.com/api_config.php +## Contributors + + + --- From 74cfd3d4b1198b11cf85a759ec38e744d0863c50 Mon Sep 17 00:00:00 2001 From: Fara7 Date: Mon, 1 Dec 2025 21:11:05 +0200 Subject: [PATCH 2/5] Apply suggestion from @Joseph-Sameh-0 Co-authored-by: Joseph Sameh Fouad <20220099@stud.fci-cu.edu.eg> --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 78af180..6624e2e 100644 --- a/README.md +++ b/README.md @@ -75,4 +75,3 @@ To get started with Qurio locally: ---- From 6455498fa5d3b759fa2ac1dbf325696dca5ab375 Mon Sep 17 00:00:00 2001 From: Fara7 Date: Mon, 1 Dec 2025 21:23:48 +0200 Subject: [PATCH 3/5] refactor: update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6624e2e..63557e1 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ This app is developed as part of the Havana Squad project and uses the Open Triv |:--:|:--:|:--:| | | | | | | | | +| | | | [Demo](https://drive.google.com/file/d/1YIb1v9tOz5LbJB7hbO4G_yUnz9R89WZS/view?usp=sharing) @@ -74,4 +75,3 @@ To get started with Qurio locally: - From 080a4c3093e40954ebaad1f6105c8481f6b90751 Mon Sep 17 00:00:00 2001 From: Fara7 Date: Mon, 1 Dec 2025 21:40:33 +0200 Subject: [PATCH 4/5] refactor: update readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 63557e1..b599a7c 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,11 @@ This app is developed as part of the Havana Squad project and uses the Open Triv | | | | |:--:|:--:|:--:| -| | | | +| | | | | | | | -| | | | +| | | | -[Demo](https://drive.google.com/file/d/1YIb1v9tOz5LbJB7hbO4G_yUnz9R89WZS/view?usp=sharing) +[Demo](https://drive.google.com/file/d/1YIb1v9tOz5LbJB7hbO4G_yUnz9R89WZS/view?usp=sharing) ## Tech Stack From 2f6cf20891d13e4bdf3268943b4634c9e413cc70 Mon Sep 17 00:00:00 2001 From: Fara7 Date: Mon, 1 Dec 2025 22:06:33 +0200 Subject: [PATCH 5/5] refactor: update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b599a7c..b83a50a 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,9 @@ This app is developed as part of the Havana Squad project and uses the Open Triv | | | | |:--:|:--:|:--:| -| | | | +| | | | | | | | -| | | | +| | | | [Demo](https://drive.google.com/file/d/1YIb1v9tOz5LbJB7hbO4G_yUnz9R89WZS/view?usp=sharing)