451 Customer Milestone 3 Report - bounswe/bounswe2024group5 GitHub Wiki

Introduction

This is the final milestone report for our group project, group bounswe2024group5. We are a group of dedicated students of CmpE451, committed to building an English Learning app, Quizzard, that features posting and solving quizzes, and interacting with other language learners in the forums.

Our team members that have contributed to the project:

Table of Contents

1. Executive Summary

1.1 Project Description

Quizzard is a language learning platform for Turkish speakers. It helps users acquire new vocabulary words by create and solve quizzes. Quizzes contain questions that are designed to help users commit new words to their long-term memory by matching words to their translations or meanings.

Users can either solve quizzes that they themselves have created or quizzes created by other users. This enables a community of language learners help each other through their learning journey. But quiz sharing isn't the only mechanism through which users can help each other. They can also answer questions related to specific words that are asked by other users on the forum.

Forum posts are also integrated with the quizzes, so that when the user solves a quiz question about the word "X", they can view the forum posts that are related to the word "X" in the same page, without ever needing to leave the quiz page.

Overall, Quizzard's quiz and forum features are the main drivers of language advancement for Turkish speaking individuals in our project.

1.2 Project Status

During the final month, since Milestone 2, our team has successfully implemented several key features requested by our customer. We've enhanced the quiz-solving experience by integrating hint images from Wikidata and implementing personalized quiz recommendations based on difficulty levels. To improve user engagement and fairness, we've implemented mechanisms to prevent users from gaining points repeatedly from the same quiz and streamlined the profile view to show only one completed attempt per quiz. We've also added the ELO-CEFR conversion table to better measure user progress.

Looking back at our previous milestone goals, we're pleased to report significant progress across all planned areas. We've successfully addressed bug fixes and improved test coverage. In terms of feature additions, in additions to the features mentioned above, we've completed CRUD operations for quizzes, added quiz upvote and question favorite features, and made substantial improvements to the difficulty algorithm in quiz creation. The implementation of follow actions, followers, and feed functionality has also been completed.

A notable achievement has been the completion of profile pages across both mobile and web clients, along with the implementation of following logic. We've also introduced a completely new leaderboard feature. Throughout this period, we've maintained a strong focus on UI/UX consistency between our mobile and web clients, ensuring a cohesive user experience across platforms.

1.3 Final Release Notes

We are pleased to announce the release of Quizzard version 0.9.0, released on December 16, 2024. This final release represents the culmination of our development efforts, introducing several major features and improvements.

Major Features added:

  • Enhanced Quiz Creation: Implemented intelligent suggestion system for correct and wrong answers
  • Interactive Quiz Solving: Added Wikidata-powered hint images and integration with related forum posts
  • Advanced Forum Features:
    • Implemented semantic search functionality
    • Added related posts display
    • Improved post categorization and linking with quizzes
  • User Engagement Features:
    • Comprehensive profile pages
    • User following system
    • Interactive leaderboard
  • Quality Assurance: Implemented unit testing across all major components.

Key Improvements

  • Quiz Difficulty Assessment: Refined our algorithm for accurately determining quiz difficulty levels, and ELO-CEFR levels match.
  • User Interface:
    • Enhanced overall UI design and user experience
    • Achieved consistency between mobile and web interfaces
    • Improved responsiveness and navigation

System Requirements

  • Mobile App:

    • Android 8.0 (API level 26) or higher
    • 100MB available storage space
    • Active internet connection

  • Web Application:

    • Modern web browsers (Chrome 88+, Firefox 87+, Safari 14+)
    • JavaScript enabled
    • Minimum screen resolution: 320px width

Installation Guide

  • Mobile App:

    • Download the APK from our releases page
    • Enable installation from unknown sources if required
    • Install the application

  • Web Application:

    • Access directly through: url
    • No installation required

Register an account or log in to start using.

Known Limitations

Please refer to the Known Issues section 1.7 for a detailed list of current limitations and their workarounds.

Acknowledgments

Special thanks to:

Our development team members for their dedication throughout the project.

1.4 Changes Made Since Last Milestone

While we haven't implemented major structural changes to our development process since the last milestone, our focus has been on delivering the features requested by our customers. We've successfully implemented all planned functionality, including hint images in quiz solving, personalized quiz recommendations, and improvements to the scoring system. These implementations were carried out while maintaining our established development workflow, which has proven effective throughout the project lifecycle.

1.5 Reflections on our Final Milestone Demo

For our final milestone presentation, we structured the demo around a realistic teacher-student scenario, effectively demonstrating how Quizzard functions in an actual educational setting. This approach allowed us to showcase both the practical applications and the user-friendly nature of our platform.

We received positive feedback from the customers, particularly regarding our user interface design. Our implementation of answer suggestions during quiz solving emerged as a highlight of the presentation. We provided a detailed explanation of our hybrid suggestion system, which combines a random algorithm with user-generated data. The system initially offers randomized suggestions but gradually improves its recommendations by learning from user inputs. When users modify the suggested options, our platform stores these modifications, creating a growing database of user-verified answer choices that enhances the quality of future suggestions for similar questions.

The interactive nature of our demo proved particularly valuable when Pofessor Uskudarli tested the application on her mobile device. This hands-on testing revealed several minor but important issues, including the absence of error messages during the login process and non-clickable profile sections in the web application. We appreciated this real-time feedback and responded promptly by releasing an update that addressed these concerns, demonstrating our commitment to continuous improvement and user experience.

1.6 Reflections on our Development Process

Looking back at our development journey, we identified several key areas of success and potential improvement. Our time management between milestones stands out as an important learning point. While we consistently took week-long breaks after each milestone, we realized that shorter breaks of 3-5 days would have been more effective. This adjustment would have helped us maintain momentum while still getting adequate rest between development phases.

When it comes to the technical side of things, we learned a lot about timing, especially with backend development. The mobile and web teams did a great job with the UI, but sometimes they had to wait around for backend endpoints to be ready before they could hook everything up. While we still hit all our deadlines, having those endpoints ready earlier would have given us more breathing room to polish the UI and run more thorough tests.

Testing proved to be an area where we could have improved our approach. Most of our testing efforts were concentrated toward the end of development, which wasn't optimal. If we had distributed our testing throughout the development cycle, we could have identified and addressed issues earlier, reducing pressure in the final stages of implementation.

One of our project's strongest aspects was team communication and collaboration. We maintained exceptional levels of interaction through our group chat, ensuring constant alignment and quick problem resolution. This robust communication framework proved invaluable in maintaining project momentum and addressing challenges promptly.

Finally, we're pretty proud of how we handled customer feedback. Whenever our customers suggested changes or new features, we found ways to work them into the project, even mid-development. This showed we could be flexible while still keeping the project on track and meeting our main goals.

1.7 Known Issues

Currently identified issues in the system include:

  • Question Like Synchronization Issue: When users like a question and subsequently create a quiz containing that question, attempting to like the same question again results in a duplicate like being recorded in the system.
  • Mobile Image Upload Limitation: The mobile application currently restricts image uploads to very small file sizes, which may impact user experience when attempting to upload higher resolution images.
  • Web Tab State Persistence: The web application currently doesn't maintain state across tab changes, resulting in reset of user quiz creation.
  • Web Profile Navigation Limitation: Profile sections in the web interface lack clickable functionality, limiting user navigation options.
  • Mobile Network Resilience: The mobile application occasionally experiences errors under poor network conditions (when connected to eduroam), though it maintains basic page display functionality.
  • Login and Registration warning messages were missing in the Web application.

2. Progress Based on Teamwork

2.1 Individual Work Table

Team Member Tasks Links
ARINÇ DEMİR Wrote acceptance criteria about domain specific features PR#465
ARINÇ DEMİR Add autocomplete to quiz creation mobile Lab Report#9
ARINÇ DEMİR Fix quiz creation endpoints Issue#501, PR#534
ARINÇ DEMİR Add hint image to quiz solving Issue#502, PR#538
ARINÇ DEMİR Add favoriting questions to mobile Issue#504, PR#563
ARINÇ DEMİR Modifications on show hint UI PR#564
ARINÇ DEMİR Fix quiz creation flatlist issue PR#566
ARINÇ DEMİR Create quiz from favorites Issue#505, PR#572
ARINÇ DEMİR Quiz creation fixes PR#590
ASUDE EBRAR KIZILOĞLU Developed profile page PR #492
ASUDE EBRAR KIZILOĞLU Completed other user profile screen and Created unified profile view with Ramazan #509
ASUDE EBRAR KIZILOĞLU Added follow logic and follow list views PR #570
ASUDE EBRAR KIZILOĞLU Fixed forum post upvoting bugs PR #545
ASUDE EBRAR KIZILOĞLU Implemented related posts in forum PR #561
ASUDE EBRAR KIZILOĞLU Added ELO-CEFR conversion table PR #546
ASUDE EBRAR KIZILOĞLU Completed quiz favorite functionality PR #569
ASUDE EBRAR KIZILOĞLU Integrated the DELETE /favorite-question endpoint PR #579
ASUDE EBRAR KIZILOĞLU Wrote unit tests for forum features PR #604
ASUDE EBRAR KIZILOĞLU Co-developed Teacher-Student scenario with Deniz and planned the final presentation Scenario
ASUDE EBRAR KIZILOĞLU Created user manual and system manual User and System manuals
ASUDE EBRAR KIZILOĞLU Organized milestone report preparation #605
HALİL UTKU ÇELİK Enhance wrong answer suggestions with other questions. PR #584
HALİL UTKU ÇELİK Implement leaderboard endpoint. PR #547
HALİL UTKU ÇELİK Implement wrong answer suggestion endpoint. PR #496
HALİL UTKU ÇELİK Increase Test Coverage For Backend. PR #570
HALİL UTKU ÇELİK Deployment.
ÖZGÜR DENİZ DEMİR
RAMAZAN ONUR ACAR Add quiz solving status to mobile Issue #476 & PR #507
RAMAZAN ONUR ACAR Fix Quiz attempt API call and add missing API calls Issue #475 & PR #472
RAMAZAN ONUR ACAR Add Leaderboard page for mobile Issue #474 & PR #525
RAMAZAN ONUR ACAR Other User's Profile Screen in Mobile Issue #509 & PR #567
RAMAZAN ONUR ACAR Add quiz suggestions after quiz finishes Issue #478 & PR #525
RAMAZAN ONUR ACAR Add related posts for the quiz solving screen on Mobile Issue #477 & PR #472
RAMAZAN ONUR ACAR Add profile page and quiz creation tests for mobile Issue #473 & PR #567
RAMAZAN ONUR ACAR Forum Testing PR #604
RAMAZAN ONUR ACAR Mobile minor enhancements PR #574
RAMAZAN ONUR ACAR Fix mobile bottom tab, duplicate delete quiz modal, home fetch PR #571
RAMAZAN ONUR ACAR Fix unit tests & quiz answer submitting, related posts, dummy leaderboard (addtl.) PR #472
RAMAZAN ONUR ACAR Lab 8 content API and docs - testing strategies PR #465
RAMAZAN ONUR ACAR Added Mobile Unit Test Report to Final Report Issue #605
SEMİH YILMAZ I developed backend endpoints and kept the API documentation up to date.
SÜLEYMAN EMİR TAŞAN Unit tests for backend PR #595
SÜLEYMAN EMİR TAŞAN Conversion favorite questions to quiz endpoint PR #575 & PR #527
SÜLEYMAN EMİR TAŞAN /hint endpoint PR #490 & PR #555
SÜLEYMAN EMİR TAŞAN Fix bugs PR #551 & PR #544 & PR #543
SÜLEYMAN EMİR TAŞAN Difficulty algorithm adjustment PR #484
SÜLEYMAN EMİR TAŞAN Edit diagrams based on feedback Issue #613
SÜLEYMAN EMİR TAŞAN Update RAM Issue #620
Fahreddin Özcan Added autofill functionality to quiz creation PR #536
Fahreddin Özcan Implemented leaderboard categories PR #530
Fahreddin Özcan Added quiz deletion feature PR #529
Fahreddin Özcan Implemented quiz recommendations PR #524
Fahreddin Özcan Enhanced question hint system by type PR #523
Fahreddin Özcan Added quiz completion warning PR #518
Fahreddin Özcan Implemented quiz link sharing PR #516
Fahreddin Özcan Added difficulty tooltip PR #515
Fahreddin Özcan Implemented question tip modal PR #514
Fahreddin Özcan Enhanced quiz results page PR #455
Fahreddin Özcan Increased test coverage for frontend features Issue #586
Fahreddin Özcan Fixed CEFR level intervals Issue #580
Fahreddin Özcan Updated IP configuration for deployment PR #602
Fahreddin Özcan Fixed answer randomization issues Issue #553
Fahreddin Özcan Added loading state indicator to profile page Issue #554
Fahreddin Özcan Fixed try again button functionality Issue #552
Fahreddin Özcan Wrote frontend test coverage reports Issue #605

2.2 Status of Requirements

The status of our Software Requirements are also updated at their wiki page. The emojis symbolize three different state:

  • ✅ is for requirements that we finished implementing it.
  • ⚠️ is for requirements that we have started working on but not finished.
  • ❌ is for requirements that we have not started.

Note that we added the missing requirements according to the feedback we received from the TA.

Requirement Number Progress
1.1.1.1 ✅ completed
1.1.1.2 ✅ completed
1.1.1.3 ✅ completed
1.1.1.4 ✅ completed
1.1.1.5 ✅ completed
1.1.1.6 ✅ completed
1.1.1.7 ✅ completed
1.1.1.8 ⚠️ in progress
1.1.1.9 ⚠️ in progress
1.1.1.10 ❌ not started
1.1.2.1 ✅ completed
1.1.2.2 ❌ not started
1.1.2.3 ✅ completed
1.1.3.1.1 ✅ completed
1.1.3.1.2 ✅ completed
1.1.3.1.3 ✅ completed
1.1.3.1.4 ✅ completed
1.1.3.1.5 ❌ not started
1.1.3.1.6 ✅ completed
1.1.3.1.7 ✅ completed
1.1.3.1.8 ✅ completed
1.1.3.1.9 ✅ completed
1.1.3.1.10 ✅ completed
1.1.3.1.11 ⚠️ in progress
1.1.3.1.12 ✅ completed
1.1.3.2.1 ✅ completed
1.1.3.2.2 ✅ completed
1.1.3.2.3 ✅ completed
1.1.3.2.4 ✅ completed
1.1.3.2.5 ✅ completed
1.1.3.2.6 ✅ completed
1.1.3.2.7 ✅ completed
1.1.3.2.8 ✅ completed
1.1.4.1 ✅ completed
1.1.4.2 ⚠️ in progress
1.1.4.3 ✅ completed
1.1.5.1 ✅ completed
1.1.5.2 ✅ completed
1.1.5.3 ❌ not started
1.1.5.4 ❌ not started
1.1.5.5 ❌ not started
1.2.1.1 ⚠️ in progress
1.2.1.2.1 ✅ completed
1.2.1.2.2 ✅ completed
1.2.1.2.3 ✅ completed
1.2.1.3 ✅ completed
1.2.1.4 ✅ completed
1.2.1.5 ❌ not started
1.2.1.6 ✅ completed
1.2.2.1 ⚠️ in progress
1.2.2.2 ✅ completed
1.2.2.2.1 ❌ not started
1.2.2.3 ❌ not started
1.2.2.4 ⚠️ in progress
1.2.2.4.1 ❌ not started
1.2.2.5 ❌ not started
1.2.3.1 ✅ completed
1.2.3.2 ❌ not started
1.2.3.3 ✅ completed
1.2.3.4 ✅ completed
1.2.3.5 ✅ completed
1.2.3.6 ✅ completed
2.1.1 ✅ completed
2.1.2 ✅ completed
2.1.3 ✅ completed
2.1.4 ✅ completed
2.2.1 ✅ completed
2.2.2 ✅ completed
2.2.3 ⚠️ in progress
2.2.4 ⚠️ in progress
2.3.1 ❌ not started
2.3.2 ✅ completed
2.3.3 ❌ not started
2.3.4 ✅ completed
2.4.1 ❌ not started
2.4.2 ❌ not started
2.4.3 ✅ completed
2.4.4 ❌ not started

2.3 API Endpoints

  • The API documentation can be directly accessed from our repo or can be rendered from swagger editor.

  • Link to the API: http://34.121.241.21/api

  • Example API calls:

    • Postman collection export can be reach here.
    • Please note that you need to include bearer token to your header for API requests other than POST /auth/register and POST /auth/login.
    • You can add the token to Authorization tab under the collection. The requests inherit from there.

    1. User Registration

    Endpoint: POST /auth/register
    Base URL: http://34.121.241.21:80/api
    Description: Registers a new user with the system.

    Required Body Content:

    • username (string): The unique username for the user.
    • name (string): The full name of the user.
    • email (string): Email address of the user.
    • password (string): Password for the user account.
    • englishProficiency (string): English proficiency level (e.g., a1, b2).

    Request Example:

    POST http://34.121.241.21:80/api/auth/register
Content-Type: application/json

{
"username": "johndoe",
"name": "John Doe",
"email": "[email protected]",
"password": "securePassword123",
"englishProficiency": "b1"
}

    Response Example

    {
    "id": 1,
    "username": "johndoe",
    "name": "John Doe",
    "email": "[email protected]",
    "profile_picture": null,
    "englishProficiency": "b1",
    "points": 750,
    "created_quizzes": 0,
    "created_at": "2024-12-20T10:00:00Z",
    "updated_at": "2024-12-20T10:00:00Z"
}

    2. Create a Quiz

    Endpoint: POST /quizzes
    Base URL: http://34.121.241.21:80/api
    Description: Creates a new quiz.

    Required Body Content:

    • title (string): Title of the quiz.
    • description (string): A short description of the quiz.
    • questions (array): List of questions, each with details.

    Request Example:

    POST http://34.121.241.21:80/api/quizzes
Authorization: Bearer <your_jwt_token>
Content-Type: application/json

{
"title": "English Vocabulary Quiz",
"description": "A quiz to test your English vocabulary skills.",
"image": "https://storage.googleapis.com/quizzard-bucket/19042e06-bfff-49c0-adce-49901b6dc726-upload.jpg",
"questions": [
    {
    "questionType": "english_to_turkish",
    "word": "apple",
    "correctAnswer": "elma",
    "wrongAnswers": ["armut", "muz", "kiraz"]
    },
    {
    "questionType": "turkish_to_english",
    "word": "kedi",
    "correctAnswer": "cat",
    "wrongAnswers": ["dog", "bird", "fish"]
    }
]
}

    Response Example

    {
    "id": 89,
    "title": "English Vocabulary Quiz",
    "description": "A quiz to test your English vocabulary skills.",
    "image": "https://storage.googleapis.com/quizzard-bucket/19042e06-bfff-49c0-adce-49901b6dc726-upload.jpg",
    "difficulty": 800.0,
    "username": "johndoe",
    "createdAt": "Fri Dec 20 14:22:29 UTC 2024",
    "updatedAt": "Fri Dec 20 14:22:29 UTC 2024",
    "noFavorites": 0,
    "questions": [
        {
            "id": 245,
            "quizId": 89,
            "questionType": "english_to_turkish",
            "word": "apple",
            "correctAnswer": "elma",
            "wrongAnswers": [
                "armut",
                "muz",
                "kiraz"
            ],
            "difficulty": 811.0
        },
        {
            "id": 246,
            "quizId": 89,
            "questionType": "turkish_to_english",
            "word": "kedi",
            "correctAnswer": "cat",
            "wrongAnswers": [
                "dog",
                "bird",
                "fish"
            ],
            "difficulty": 789.0
        }
    ]
}

    3. Get Correct Answer Suggestions

    Endpoint: GET /get-correct-answers
    Base URL: http://34.121.241.21:80/api
    Description: Returns correct answer suggestions for a word and question type.

    Required Query Parameters:

    • word (string): The word for which suggestions are needed.
    • questionType (string): The type of question. Must be one of:
      • english_to_sense
      • english_to_turkish
      • turkish_to_english

    Request Example:

    GET http://34.121.241.21:80/api/get-correct-answers?fast=house&questionType=english_to_turkish
Authorization: Bearer <your_jwt_token>

    Response Example:

    [
    "süratli",
    "çabuk",
    "hızlı",
    "yapışmak",
    "oruç tutmak",
    "dayanmak",
    "perhiz yapmak",
    "tez canlı",
    "çıkmaz",
    "sımsıkı"
]

    4. Reply a Post

    Endpoint: POST /posts/{postId}/replies
    Base URL: http://34.121.241.21:80/api
    Description: Creates a new reply to a specific forum post.

    Path Parameters:

    • postId (integer): The ID of the post to which the reply belongs.

    Required Body Content:

    • content (string): The content of the reply.

    Request Example:

    POST http://34.121.241.21:80/api/posts/12/replies
Content-Type: application/json
Authorization: Bearer <your_jwt_token>

{
    "content": "This is my reply to the post."
}

    Response Example:

    {
    "id": 456,
    "postId": 12,
    "username": "johndoe",
    "content": "This is my reply to the post.",
    "createdAt": "2024-12-20T14:30:00Z",
    "updatedAt": "2024-12-20T14:30:00Z"
}

2.4 UI - UX

Code Repository Links

  • Mobile UI Implementation for Pages: repo
  • Web UI Implementation for Pages: repo
  • Color theme for Mobile and Web: Violet palette

The following sections include links to the screenshots and the implementation per interface for mobile and web.

We created a wiki page for the screenshots of each UI interface pages and we linked them here as well.

Mobile Interface

Authentication

  • Login Screen
    • Description of key features: Login functionalities
    • Link to implementation: code
  • Registration Screen
    • Description of key features: Register functionalities
    • Link to implementation: code

General

  • Home Screen
    • Description of key features: Displays Quizzes for different levels
    • Link to implementation: code
  • Elo-CEFR Conversion Table
    • Description of key features: Displays the ELO to CEFR levels conversion logic.
    • Link to implementation: code
  • Profile Screen
    • Description of key features: Displays personal information as well as personal stats.
    • Link to implementation: code
  • Other Users' Profile Screen
    • Description of key features: Displays other user's personal information as well their own quizzes and posts.
    • Link to implementation: code
  • Profile Settings Screen
    • Description of key features: Allows editing some personal details.
    • Link to implementation: code
  • Leaderboard Screen
    • Description of key features: Displays weekly and monthly high achieving users.
    • Link to implementation: code
  • Follow List Screen
    • Description of key features:
    • Link to implementation: code

Quiz Pages

  • Quiz Creation Screen
    • Description of key features: Allows users to create their own quizzes.
    • Link to implementation: code
  • Quiz Welcome Page
    • Description of key features: Displays some details of a quiz.
    • Link to implementation: code
  • Quiz Solving Screen
    • Description of key features: Allows users to solve any quiz, question by question.
    • Link to implementation: code
  • Quiz Finish Screen
    • Description of key features: Displays end of quiz information, including the user's score and recommended quizzes.
    • Link to implementation: code

Forum Pages

  • Forum Screen
    • Description of key features: Displays forum posts in a feed.
    • Link to implementation: code
  • Search Words Screen
    • Description of key features: Allows users to search words for forum posts.
    • Link to implementation: code
  • Search Results Screen
    • Description of key features: Displays the forum search results.
    • Link to implementation: code
  • Create Question Screen
    • Description of key features: Allows users to post their questions in forum.
    • Link to implementation: code
  • Question Detail Screen
    • Description of key features: Displays one forum post, as well as its replies and related posts. Also allows users to add a reply to the post.
    • Link to implementation: code

Web Interface

Authentication

  • Login Screen
    • Description of key features: Login functionalities
    • Link to implementation: code
  • Registration Screen
    • Description of key features: Register functionalities
    • Link to implementation: code

General

  • Home Screen
    • Description of key features: Displays Quizzes for different levels
    • Link to implementation: code, code
  • Elo-CEFR Conversion Table
    • Description of key features: Displays the ELO to CEFR levels conversion logic.
    • Link to implementation: code
  • Profile Screen
    • Description of key features: Displays personal information as well as personal stats.
    • Link to implementation: code
  • Other Users' Profile Screen
    • Description of key features: Displays other user's personal information as well their own quizzes and posts.
    • Link to implementation: code
  • Profile Settings Screen
    • Description of key features: Allows editing some personal details.
    • Link to implementation: code
  • Leaderboard Screen
    • Description of key features: Displays weekly and monthly high achieving users.
    • Link to implementation: code

Quiz Pages

  • Quiz Creation Screen
    • Description of key features: Allows users to create their own quizzes.
    • Link to implementation: code
  • Quiz Solving Screen
    • Description of key features: Allows users to solve any quiz, question by question.
    • Link to implementation: code
  • Quiz Finish Screen
    • Description of key features: Displays end of quiz information, including the user's score and recommended quizzes.
    • Link to implementation: code

Forum Pages

  • Forum Screen
    • Description of key features: Displays forum posts in a feed.
    • Link to implementation: code
  • Search Words Screen
    • Description of key features: Allows users to search words for forum posts.
    • Link to implementation: code
  • Create Question Screen
    • Description of key features: Allows users to post their questions in forum.
    • Link to implementation: code
  • Question Detail Screen
    • Description of key features: Displays one forum post, as well as its replies and related posts. Also allows users to add a reply to the post.
    • Link to implementation: code

Also refer to our User Experience plan.

2.5 Standards

We chose ARIA as our web standard. To achieve it we used various ARIA attributes in our HTML to offer more accesibility. You can see examples of those attributes in our quiz listing page. There, we labeled element with regards to their roles so that screen readers can easily identify which element serves what purpose. We also gave ARIA labels and decriptions to certain elements so that they can be read out loud by screen readers.

2.6 Scenarios

We crafted an elaborate scenario encompassing all core functionalities of our project. We followed this scenario during our final presentation as well (but we had to keep it short to fit into the time we were given in the presentation). You can view our Teacher-Student scenario outline from the wiki.

The following core features were included in the scenario:

  • Logging in to the app.
  • Creating a quiz by entering a title and a description, uploading an image, choosing a question type and creating several questions by entering a valid word (e.g. a valid English word for Eng->Tr and Meaning question types and a valid Turkish word for the Tr->Eng question type).
  • Benefiting from autocomplete functionality, when entering the question word.
  • Choosing a correct answer among the suggested answers for the provided word and question type.
  • Using the suggested 3 wrong answer choices, or alternatively, inputing your own wrong choices.
  • Creating a forum post to ask questions about some words.
  • Checking your current ELO - CEFR level from profile page.
  • Searching for the quiz title in the home page to find a specific quiz. (only on web)
  • Navigating to the quiz creator user's profile.
  • Following other users.
  • Solving quizzes.
  • Benefitting from the hint images (coming from Wikidata) while solving the quiz.
  • If left the quiz unfinished, coming back to the same quiz later to find your previous answers retrieved.
  • Liking certain quiz questions.
  • Creating quizzes from liked questions.
  • Checking related posts to the quiz questions, while solving the quiz.
  • Viewing how many points you gained in the Quiz Finish screen.
  • Viewing recommended quizzes (based on quiz difficulty) in the Quiz Finish screen.
  • Searching for forum posts in the Forum feed (semantic search is available. E.g. when "furious" is searched, posts on the word "angry" are also displayed).
  • Viewing a forum post detail.
  • Replying to a forum post.
  • Liking forum posts.
  • Viewing related posts under the forum post (based on semantic relation).
  • Viewing your own quizzes, forum posts, and previous quiz attempts on your profile page.
  • Changing the profile details such as profile picture, name and email.
  • Viewing the accounts you follow and your followers. (only on mobile)
  • Viewing the leaderboard and weekly and monthly top users under the categories "most points earned", "most quizzes solved", and "most quizzes created".
  • Viewing the ELO-CEFR conversion table from the top of the app (the question mark "?"), to remember the correspondence between the ELO scores and CEFR language levels.

3. Individual Contributions

3.1 ARINÇ DEMİR

Member

Arınç Demir - Group 5 (Quizzard) - Android

Responsibilities

Android Development, UI Improvement

Main Contributions

Here is what I did in the labs:

  • I Wrote the acceptance criteria about domain-spesific features. Lab Report #8
  • I added the autocomplete feature to quiz creation in mobile. Lab Report #9

In addition to that, I discussed features and progress with my group mates in the labs.

Here is what I implemented in my own time:

  • Fix quiz creation endpoints. #501, PR#534
  • Add hint image to quiz solving. #502, PR#538
  • Add favoriting questions. #504, PR#563
  • Create quiz from favorite questions. #505, PR#572
  • Reviewed bunch of pull requests.

Also, I navigated the web and mobile apps in the presentation on my computer.

Pull Requests

Own PR's

  • Fix quiz creation endpoints. PR#534
  • Add hint image to quiz solving. PR#538
  • Add favoriting questions to mobile. PR#563
  • Modifications on show hint. PR#564
  • Fix quiz creation flatlist issue. PR#566
  • Create quiz from favorites. PR#572
  • Quiz creation fixes. PR#590

Reviews

Unit Tests

Unfortunately, my unit tests have not made it into the milestone 3 release. I started it but because they were not functional, I didn't publish them.

Additional Information

I update my personal page regularly. You can see there when I made my contributions and how long they took.

3.2 ASUDE EBRAR KIZILOĞLU

Member:

Asude Ebrar Kiziloglu, Group 5, Android.

Responsibilities:

Group Communicator, Mobile (Android) Developer, Documenter.

Main Contributions:

Mobile Development:

  • Implemented comprehensive profile page functionality including "My Quizzes", "My Posts", and "My Quiz Attempts" sections.
  • Created unified profile view system for both personal and other users' profiles with Ramazan.
  • Added following/follower functionality with user navigation.
  • Fixed forum post upvoting bugs and implemented related posts feature.
  • Enhanced UI with collapsible sections for replies and related posts.
  • Coordinated with frontend team for consistent color palette across platforms.

Feature Implementation:

  • Added ELO-CEFR conversion table as per customer request.
  • Completed quiz favorite functionality.
  • Implemented unit tests for forum features.
  • Collaborated on testing with Ramazan.

Project Management & Documentation:

  • Co-developed Teacher-Student scenario for the presentation with Deniz.
  • Managed lab agendas and task distribution.
  • Maintained Project Plan.
  • Led this milestone report organization.
  • Wrote the Executive Summary, 4. Deliverables sections, and specific subsections (2.2, 2.4, and 2.6) of the report.
  • Created user and system manuals.
  • Updated software requirements by adding the missing ones and updating the requirement status based on TA feedback.
  • Participated in all team gatherings, in the lab and outside. Kept constant communication with the team. Was grateful for our united hard work!

The following sections include the issues I worked on:

Code-Related Significant Issues:

Management-Related Significant Issues:

  • #612: Plan for the final presentation scenario.
  • #605: Organizing to preparing this report.
  • #614: Preparing the User Manual.
  • #615: Preparing the System Manual.
  • #317: Arrange the Project plan Roadmap view.

Pull Requests:

Created

Reviewed/Merged

Unit Tests:

I wrote unit tests for the forum functionalities. See ForumScreen.test.js, QuestionDetailScreen.test.tsx and QuizCreationScreen.test.js in the test directory. PR #604

3.3 FAHREDDİN ÖZCAN

Member

Fahreddin Özcan, Grup 5, Frontend

Responsibilities

Frontend Development, Testing Implementation, Feature Development, UI/UX Improvements, Documentation

Main Contributions

In this milestone, I worked on making our platform more user-friendly and stable. I built several new features and fixed important bugs to improve how users interact with our quizzes.

I built the leaderboard feature, which lets users see top performers in different categories. I also added quiz recommendations that show up after users finish a quiz, helping them find new content to practice with. To make quizzes more engaging, I added features like favoriting quizzes and questions, and made it easy to share quiz links with others.

For user alerts and feedback, I added warning messages that tell users when they've already completed a quiz, and hints that help during quiz-taking. I also built the follow/follower system so users can connect with each other.

I spent a lot of time fixing problems with our quiz system. I fixed how difficulty levels are calculated, made sure questions appear in the right order, and fixed issues with the try-again button. I also added loading spinners so users know when the page is working, and made the profile pages work better.

To keep our code quality high, I added more tests to catch bugs early. I also worked closely with our backend team to make sure all our features worked smoothly with their APIs.

Code-related significant issues

Management-related significant issues

Pull Requests

Created

Reviewed

Unit tests

I've introduced some tests in PR #587, which covers the features below:

Additional Information

During this milestone, I focused on making our app more reliable and easier to use. I spent time testing features thoroughly and fixing bugs that users reported. The hardest part was getting all the quiz features to work together smoothly, especially when users are taking quizzes or checking their results. I also made sure that the pages load faster and show helpful information while users wait.

Working with the backend team was sometimes tricky when we were building new features, but we managed to sort out any issues through regular communication. I'm particularly proud of how the leaderboard and quiz recommendation systems turned out - they make the app more engaging for users.

3.4 HALİL UTKU ÇELİK

Responsibilities:

  • Backend development
  • Deployment

Main Contributions:

In this milestone, I focused on enhancing the backend functionality of our platform. I worked on improving the quiz creation system, and fixing bugs.

I implemented wrong answer suggestion endpoint. This feature suggests wrong answers to the user while creating a quiz for given question. The wrong answer suggestion algorithm is based on the semantic links between the words. The endpoint suggests the most relevant wrong answers to the user.

I also implemented the leaderboard endpoint which returns the top users in different categories. The leaderboard endpoint is used to display the top users in the frontend.

Code-Related Significant Issues:

  • #584: Enhance wrong answer suggestions with other questions.
  • #547: Implement leaderboard endpoint
  • #496: Implement wrong answer suggestion endpoint
  • #470: Increase Test Coverage For Backend

Management-Related Significant Issues:

  • #607: Individual Contributions (everyone)
  • #606: 2.1 Individual Work Table (everyone)

Pull Requests:

Created

  • PR #596: Fix answer suggestion tests
  • PR #594: Limit leaderboard with 10 users
  • PR #591: Fix duplicate wrong answer suggestions
  • PR #588: Enhance wrong answer suggestions and write unit tests
  • PR #583: Implement answer suggestion endpoints
  • PR #526: Implement leaderboard functionality with service and controller

Reviewed/Merged

Tests:

  • I wrote unit tests for answer suggestion endpoints.
  • I also tested the integration of backend and frontend after each deployment and reported the issues to the team.

Additional Information:

  • While the latest deployment was being done, I encountered an issue with the storage of the VPS and I had to fix it. I increased the disk space of the VPS and rebooted the server. After that, the deployment was successful, but since the IP address of the server was not static, we needed to update the IP address in the frontend and mobile.

3.5 ÖZGÜR DENİZ DEMİR

Role: Frontend Web Application

Responsibilities

I implemented several of the features that we added to our application in this milestone. I was responsible for creating the user interfaces that enable our users to take advantage of those new features.

### Main Contributions

I implemented the following features:

  • Question favorite: #494
  • Quiz favorite: #494
  • Follow: #500
  • Quiz update: #533
  • Create quiz from favorites: #535

Pull Requests

Unit Tests

I wrote one unit test to see if the follow button that I implemented earlier was working correctly. You can see the source code here.

Additional Information

I, along with Ebrar, came up with the presentation scenario.

3.6 RAMAZAN ONUR ACAR

Member:

Ramazan Onur Acar, Group 5, Android.

Responsibilities:

  •  Mobile Developer

Main Contributions:

In this milestone, I focused on enhancing the mobile platform's usability and stability by building new features, fixing critical bugs, and improving the overall user experience.

I added a quiz-solving status feature, allowing users to track their progress more easily. The leaderboard page was also implemented, letting users view top performers in real-time with different metrics. To improve quiz engagement, I added quiz suggestion feature that recommends new content after users finish a quiz, and added related posts on the quiz-solving screen to provide deeper insights, allowing users to see all related posts and their replies.

I worked on improving the mobile quiz system by fixing the quiz attempt API calls and adding missing APIs. I also fixed mobile unit tests and added new tests for profile pages and quiz creation, ensuring robust functionality. Additionally, I enhanced the UI with custom confirmation and information modals, pagination for the forum post screen, better navigation for completed quizzes, and updated fetching logic for the Home Screen to improve performance.

Code-Related Significant Issues:

  • #476: Add quiz solving status to mobile
  • #475: Fix Quiz attempt API call and add missing API calls for this screen
  • #474: Add Leaderboard page for mobile
  • #509: Other User's Profile Screen in Mobile
  • #478: Add quiz suggestions after quiz finishes
  • #477: Add related posts for the quiz solving screen on Mobile
  • #473: Add profile page and quiz creation tests for mobile

Management-Related Significant Issues:

  • #607: Individual Contributions (everyone)
  • #606: 2.1 Individual Work Table (everyone)
  • #605: Prepare the Final Milestone Report

Pull Requests:

Created

  • PR #604: Forum Testing
  • PR #574: Mobile minor enhancements
  • PR #571: Fix mobile bottom tab, duplicate delete quiz modal, home screen fetch logic
  • PR #567: Mobile/profile tests and forum
  • PR #525: Add/mobile quiz recommendations, enhance UI, add leaderboard
  • PR #507: Fix status and last activity time and enhance UI for quiz attempts of mobile
  • PR #472: Fix unit tests & quiz answer submitting and add related post functionality and dummy leaderboard
  • PR #465: Lab 8 content API and its documentation - testing strategies

Reviewed/Merged

  • PR #492: Implement Profile Page Sections in Mobile
  • PR #534: Fix quiz creation endpoints
  • PR #538: Add hint image to quiz solving
  • PR #545: Forum upvoting bugfix and UI modifications for mobile
  • PR #550: Hotfix delete quiz functionality
  • PR #563: Favorite questions mobile
  • PR #566: Fix quiz creation flatlist
  • PR #569: Favorite quizzes mobile
  • PR #570: Following follower pages in Mobile
  • PR #572: Quiz from favorites mobile
  • PR #573: Hotfix: Handle 0 following & 0 follower cases
  • PR #593: Hotfix quiz solve & forum reply
  • PR #601: Change IP

Unit Tests:

  • Testing Stratagies: I worked on testing stratagies with Semih and Süleyman in LAB 8.
  • Forum Testing: I collaborated with Ebrar to fix and refine some of her unit tests for forum functionalities. PR #604
  • Profile Page and Quiz Creation Tests: Implemented unit tests to ensure the reliability of profile pages and quiz creation features. Issue #473

Additional Information:

  • In this milestone, other than the issues on functionality and performance of the app, I tried to fix any ill-looking component and page, and provide a modernistic look in the mobile. Therefore, I added some modals, changed some styles etc. Most of them are not mentioned in the issues and PR's, but mentioned in the commits inside them.

3.7 SEMİH YILMAZ

Member:

Semih Yılmaz, Group 5, Backend

Responsibilities

Backend Development, API Documentor, Database Designer

Main Contributions

My main responsibility was to develop backend endpoints.

Code-related significant issues

Management-related significant issues

Pull Requests

Created

Collaborated

Reviewed/Merged

Unit Tests

I wrote tests for the following classes: AnswerSuggestionService, PostService, QuestionService, QuizAttemptService, AnswerSuggestionService, QuestionAnswerService, QuizService, ReplyService, UpvoteService, and UserService

The unit tests are located here.

Additional Information

I moderated the meeting which we plan what to do for this milestone. I tested backend, web and mobile app and then reported/fixed the bugs. Also I wrote API endpoints part of this report.

3.8 SÜLEYMAN EMİR TAŞAN

Member:

Süleyman Emir Taşan, Group 5, Backend.

Responsibilities:

Backend Developer, Database, API-DOC.

Main Contributions:

My priority in this Milestone was to fix the score system and score calculation algorithm that we did not like from the 2nd milestone. I also received significant help from Semih here. Currently, we have a much better score calculation system in our application than the previous ones. In the next stage, I wrote the /hint endpoint to be able to add the wikidata we received as feedback from the 2nd milestone and to add hints to the questions. First of all, there are wikidata entries by word here and I select the most relevant (correct) entries and create 2 image URLs from there (if any) and send them to the web and mobile teams. Then Semih did some optimizations in this endpoint, after that I changed number of URLs to 4 (previously 3).

In the next stage, I wrote the endpoint to create an automatic quiz from favorited questions. In this way, I ensured a very positive experience for the user.

Later, I realized that the responses of the "GET /favorite-questions" and "GET /favorite-quizzes" endpoints were wrong and I corrected this.

After completing the code part, I worked to complete the unit tests of the service layer. I wrote unit tests for FavoriteQuestionService, FeedServiceTest, FileUploadService, FollowingService, LeaderboardService and WikidataService.

I edited the diagrams based on feedback from MS1. Then I updated the RAM. I participated in all labs and had open communication with the team. This allowed the problems to be solved very quickly with my team and the backend group. This is how I completed my last milestone with my team. I was very happy to be with this team.

The following sections include the issues I worked on:

Code-Related Significant Issues:

  • #470: Unit tests for backend
  • #483: Adjust score system
  • #491: Hint for Questions
  • #498: Conversion favorite questions to quizzes
  • #508: Revision for point calculation
  • #541: Fix GET Response of Favorite Quiz and Question Endpoint
  • #542: Fix response of "POST /auth/login" details in api-doc
  • #556: Prevent irrelevant images in response of /hint
  • #575: Add Description and Image Fields to Favorite Questions Endpoint

Management-Related Significant Issues:

  • #620: Update RAM
  • #613: Edit diagrams based on feedback

Pull Requests:

Created

  • PR #595: Unit tests
  • PR #575: Update from favorites endpoint
  • PR #555: Getting 4 images from wikidata (previously we get 3)
  • PR #551: Fix bug in FavoriteQuestionResponse
  • PR #544: Fix bug in GET favorite quiz and question endpoints
  • PR #543: Fixed wrong response of /auth/login
  • PR #527: Conversion favorite questions into a quiz
  • PR #490: Wikidata usage for hint
  • PR #484: Difficulty algorithm adjustment

4. Deliverables

4.1 User Manual

You can view our detailed user manual in wiki.

The manual contains the following information:

  • Getting started guide
  • Account creation and management
  • Navigation through the app
  • Creating and solving quizzes
  • Forum participation
  • Profile management
  • Scoring system explanation
  • FAQ section
  • Troubleshooting guide

4.2 System Manual

You can view our detailed system manual in wiki.

The manual contains the following information:

  • System requirements (hardware/software)
  • Build and Deploy instructions
  • Database setup instructions
  • API configuration
  • Environment configuration
  • Backup and recovery procedures
  • Security configurations
  • Maintenance procedures
  • Troubleshooting

4.3 Software Requirements Specification

Software Requirements Specification can be reached from here.

4.4 Software design documents

Note that we improved our UML diagrams based on the feedback we received from the TA.

4.5 User scenarios and mockups

Note that we improved our user scenarios after receiving feedback about them, after Milestone 1.

4.6 Project plan

We utilize Github's Projects Roadmap feature to manage our project plan effectively. This visual representation allows us to monitor our progress according to the upcoming deadlines, such as the milestones. Additionally, it facilitates communication between sub-teams (backend, frontend, and mobile), ensuring that everyone is informed of each other's progress. Ebrar is responsible to update the Project plan frequently, and other team members also review and revise it often. You can view the screenshot of our project plan from the wiki page.

4.7 Unit Tests

4.7.1 Mobile Unit Test Report

Mobil unit tests are located here.

Scope and Coverage

Achieved:

  • Core UI Components:

    • Example: CustomButton.tsx
      • Coverage: ~100% lines covered.
      • Explanation: Straightforward rendering and press event tests ensure stable and fully covered code.

  • Question Type Dropdown:

    • File: BaseDropdown.tsx
      • Coverage: ~66.66% lines covered.
      • Explanation: Testing basic dropdown functionality and state changes confirms that selecting different question types works as intended, partially validating quiz creation workflows.

  • Basic Utility Hooks:

    • Example: useColorScheme.ts
      • Coverage: ~25% lines covered.
      • Explanation: Limited scenarios tested, but demonstrates at least partial verification of UI theming logic.

Aimed but Not Fully Achieved:

  • Registration & Login (LoginScreen.tsx, RegisterScreen.tsx):

    • Coverage: 0%
    • Explanation: No tests verify credential handling or form validation, leaving these critical paths unchecked.

  • Profile Updates & Image Upload (ProfileSettingsScreen.tsx):

    • Coverage: ~0%-5%
    • Explanation: Tests needed to ensure updating user info and images works correctly. Without them, errors in this feature could go unnoticed.

  • Quiz Creation & Scoring (QuizCreationScreen.tsx, QuizSolvingScreen.tsx):

    • Coverage: ~0%-10%
    • Explanation: Complex quiz logic (e.g., scoring, validating question inputs) remains under-tested, risking undetected issues in the user experience.

  • Forum Interaction (ForumScreen.tsx, CreateQuestionScreen.tsx):

    • Coverage: ~0%-5%
    • Explanation: Interactive features (posts, replies, upvotes) are minimally tested, leaving these functionalities prone to hidden bugs.

  • Search Functionality:

    • Coverage: 0%
    • Explanation: -

Test Files and Outcomes

The following test files were executed:

  1. CreateQuestionScreen.test.tsx
  2. ForumScreen.test.tsx
  3. ProfileScreen.test.js
  4. ProfileSettingsScreen.test.js
  5. QuestionDetailScreen.test.tsx
  6. QuizCreationScreen.test.js

Assigned Outcomes:

  • Passed:

    • CreateQuestionScreen.test.tsx

      • Explanation: The provided code checks basic UI elements (placeholders, submit button) and does not rely on complex data fetching or user input scenarios. The simplicity leads to consistent passing tests.

    • ProfileScreen.test.js

      • Explanation: The "can be rendered" test ensures the component mounts without errors. Since more complex tests are skipped, the remaining simple checks pass reliably.

    • QuestionDetailScreen.test.tsx

      • Explanation: Fetch mocks return expected data, and the test verifies basic text rendering. Straightforward network responses and UI checks result in passing tests.

  • Failed:

    • ForumScreen.test.tsx

      • Explanation: While the code attempts to fetch forum posts and verify their presence, the low coverage and complexity (e.g., multiple await/waitFor calls, mock data) lead to unstable results. Tests that rely on asynchronous data handling fail if responses or UI updates do not align perfectly with expectations.

    • ProfileSettingsScreen.test.js

      • Explanation: Although this file includes a success scenario for updating the profile, the complexity of handling profile data, PUT requests, and error states might lead to failures. When a test expects certain outcomes (like a successful alert and navigation) but the underlying logic or API calls don’t match perfectly, the test fails.

    • QuizCreationScreen.test.js

      • Explanation: The test triggers a submit event and expects API responses. Complexities in quiz creation, such as handling multiple questions and image uploads, may not be fully accounted for. If responses or mock implementations differ from expected behavior, tests fail.

Test Statistics:

  • Test Suites:

    • Total: 6
    • Passed: 3
    • Failed: 3
    • Pass Rate: 50%

  • Individual Tests:

    • Total: 12
    • Passed: 5 (~41.6% pass rate)
    • Failed: 6
    • Skipped: 1

Coverage Overview (All Files):

  • Statements: ~4.67% covered
  • Branches: ~5.31% covered
  • Functions: ~5.31% covered
  • Lines: ~5.31% covered

Except some core components and the question type dropdown, most critical features remain at very low coverage.

Conclusion

Current test coverage and reliability vary greatly. Basic UI components and question type selection are partially validated, but essential user paths—authentication, profile management, quizzes, forum features, and search lack sufficient tests. The provided code for each test file shows both simple successes and complex failures, reflecting a need for more targeted, robust testing strategies.

Below, screenshots from the test results could be seen for further insight.

Test Result 1 Test Result 2

4.7.2 Frontend Unit Tests

Report

7.2.2.1 Test Execution Summary

  • Total Test Files: 10 (9 passed, 1 failed)
  • Total Tests: 50 (49 passed, 1 failed)
  • Execution Time: 8.02s
    • Transform: 2.05s
    • Setup: 4.34s
    • Tests: 1.41s

7.2.2.2 Coverage Metrics

  • Statements: 12.68% (173/1364)
  • Branches: 10.46% (75/717)
  • Functions: 10% (37/370)
  • Lines: 12.93% (168/1299)

7.2.2.3 Component Analysis

High Coverage (>80%):

  • CreatePost.tsx: 83.92% statements, 71.87% branches
  • HostContext.tsx: 100% all metrics
  • copy-quiz-link-button.tsx: 100% all metrics
  • quiz-recommendations.tsx: 100% all metrics

Medium Coverage (30-80%):

  • profile-page.tsx: 72.72% statements
  • profile-photo.tsx: 55.55% lines

Low Coverage (<30%):

  • Most API hooks showing <20% coverage
  • App.tsx: 0% all metrics
  • quiz-result.tsx: 0% all metrics
  • forum-integration.tsx: 0% all metrics

7.2.2.4 Failed Tests

  • quiz-recommendations.test.tsx: Unable to find element with text "C1"

7.2.2.5 Next Steps

  1. Fix failed test in quiz-recommendations.test.tsx
  2. Address React 18 compatibility warnings
  3. Prioritize testing of API hooks
  4. Increase coverage of core components

4.7.3 Backend Unit Tests

Backend Unit Tests are located at the tests directory at the repo.

Coverage Report

element class, % method, % line, %
all classes 49% 36% 39%
service layer 100% 77% 58%

The coverage seems low when we look at all classes. However, when we exclude classes which does not have any business logic the coverage is good enough.

4.8 Database Content

Mock Database Content can be reached from here.

Main Authors

Ebrar

⚠️ **GitHub.com Fallback** ⚠️