User Manual - bounswe/bounswe2024group5 GitHub Wiki

User Manual for Quizzard: An English Learning Application

1. Getting Started Guide

Mobile Application:

  1. Download the App:
    • Obtain the APK from our official release page.
    • Install it on an Android device (Android 8.0 or higher).
  2. Enable Installation:
    • Allow installations from unknown sources in your device settings (if prompted).
  3. Open the App:
    • Launch the app and sign in or register to get started.

Web Application:

  1. Access the Website:
  2. Login or Register:
    • Use your credentials to log in or sign up as a new user.

2. Account Creation and Management

  • Sign Up:
    • Provide your name, email, and a secure password.
  • Login:
    • Enter your credentials to access your account.
  • Profile Management:
    • Update your profile picture, name, and email from the profile settings.
    • View your followers, follow others, and check your leaderboard rankings.

3. Navigation Through the App

  • Home Page:
    • Browse quizzes or use the search bar to find specific quizzes by title (web only).
  • Forum:
    • Participate in discussions or create posts for specific words.
  • Profile:
    • Access your quizzes, solved attempts, and forum posts.
  • Leaderboard:
    • View weekly/monthly top users for points, quizzes solved, and quizzes created.

4. Creating and Solving Quizzes

Quiz Creation:

  1. Enter Details:
    • Add a title and description for your quiz.
  2. Add Questions:
    • Choose a type: Eng->Tr, Tr->Eng, or Meaning.
    • Enter a valid word for the question.
    • Select correct and incorrect answer choices from suggestions or input manually.
  3. Upload Images:
    • Attach a quiz image (optional).

Quiz Solving:

  1. Start Quiz:
    • Select a quiz from the home page.
  2. Hints and Related Posts:
    • Use Wikidata images as hints and view related forum posts.
  3. Save Progress:
    • Leave mid-way and return to resume from where you left off.
  4. Quiz Completion:
    • Check your score and receive personalized quiz recommendations.

5. Forum Participation

  • Create Posts:
    • Ask or answer questions related to specific words.
  • Semantic Search:
    • Find related posts using synonyms or similar terms.
  • Engage:
    • Like posts, reply to threads, and view related discussions.

6. Profile Management

  • Track Progress:
    • View your ELO score and CEFR level.
  • Edit Details:
    • Change your profile picture, name, and email.
  • Leaderboard Participation:
    • Aim for top ranks in quizzes solved or created.

7. Scoring System Explanation

  • ELO-CEFR Conversion:
    • Check the "?" section to understand your ELO score and corresponding CEFR level.
  • Quiz Points:
    • Earn points by solving quizzes or creating new ones.
  • Leaderboard Rankings:
    • Rankings reset weekly/monthly.

8. FAQ Section

  • Why can’t I log in?
    • Ensure your credentials are correct. Check your internet connection.
  • How do I upload images?
    • Attach images within size limits (current limitation: small sizes only).
  • What if I encounter an error during quiz creation?
    • Double-check your input or try refreshing the app.

9. Troubleshooting Guide

Common Issues:

  1. Duplicate Likes:
    • Avoid liking the same question multiple times.
  2. Login Errors:
    • Missing error messages during login are being addressed. Try again or contact support (the development team) if needed.
  3. Network Problems:
    • If on a poor network (e.g., Eduroam), switch to a stable connection.

Contact Support:

Author

Ebrar