Skip to content

User Documentation

Jump to bottom
Ap13Crow edited this page Apr 21, 2025 · 9 revisions

Welcome to the Mia Learning App! This console-based application assists users in tracking courses, managing notes, storing vocabulary, and quizzing themselves on newly learned words. Below you'll find everything you need to get started.

Table of Contents

  1. [Getting Started]
  2. [Main Menu Overview]
  3. [Managing Courses and Modules]
  4. [Managing Notes]
  5. [Vocabulary Management]
  6. [Managing Resources]
  7. [Managing Quizzes]
  8. [Progress Summary (Dashboard)]
  9. [Global Search]
  10. [Troubleshooting & FAQs]

Getting Started

  1. Download and Install

    • Obtain the latest version of the Mia Learning App from the [Releases] page.
    • Extract the contents of the downloaded .zip file to your desired location.

  2. Launch the Application

    • Windows/macOS/Linux Users: Ensure [.NET 8.0 Runtime] is installed. Then, open the folder LearningApp_v2.1.0 in the terminal, and execute: 
      dotnet LearningApp.dll

  3. Navigate the Console

    • Upon launching, you'll see a main menu with numbered options. Type the corresponding number and press Enter to select.

Main Menu Overview

=== My Learning App - Main Menu ===
1) Manage Courses & Modules
2) Manage Notes
3) Manage Vocabulary
4) Manage Resources
5) Manage Quizzes
6) Global Search
7) Progess Dashboard
8) Exit
Enter your choice:

Each option corresponds to a primary feature in the Mia Learning App.

1) Managing Courses and Modules

Menu of this section

=== Courses & Modules ===
1) View Courses
2) Add Course
3) Update Course Progress
4) Delete Course
5) Manage Modules
0) Back to Main Menu

With 0 you can get back to the main menu.

Adding a New Course

  1. From the main menu, select 1) Manage Courses & Modules.
  2. Choose 2) Add Course.
  3. Enter the course title (e.g., "Spanish 101").
  4. The course will be created with 0% progress and saved to the database.

Viewing and Updating Course Progress

  • View Courses: Choose 1) View Courses from the "Manage Courses & Modules" menu.
    • You'll see a list: 
      1) Spanish 101 - 0% complete (Notes: 0)
2) Photography Basics - 30% complete (Notes: 2)
  • Update Progress: From the "Manage Courses & Modules" menu, choose 3) Update Course Progress.
    • Select the course number, then enter a new progress value (0–100).

Deleting a Course

  1. From the "Manage Courses & Modules" menu, select 4) Delete Course.
  2. Choose the course you wish to delete.
  3. Confirm the deletion when prompted. This will remove the course and all associated modules, notes, resources, and quizzes.

Managing Modules

  1. From the "Manage Courses & Modules" menu, select 5) Manage Modules.
  2. Choose the course you want to manage modules for.
  3. You can then:
    • Add a Module: Enter the module title.
    • Toggle Module Completion: Mark modules as complete or incomplete.

2) Managing Notes

Menu of this section

1) Add  2) List by Course  3) Search  4) Back

By selection option 4, you will be send back to the main menu.

Adding a Note

  1. Choose 2) Manage Notes from the main menu.
  2. Select 1) Add a New Note.
  3. Pick the course you want the note to attach to (remark: If no course is yet listed, you have to add a course first and then start to add a note to it. Available courses are then listed and can be selected by number).
  4. Enter the note content, such as "Review chapters 2 & 3" or a link to relevant resources.
  5. A confirmation message will appear when the note is saved.

Viewing or Searching Notes

Within Manage Notes, you can:

  • 2) View Notes by Course:
    • Select a course to see all notes attached to it.
  • 3) Search Notes:
    • Type a keyword to find notes that contain it in their content.

3) Vocabulary Management

Menu of this section

=== Vocabulary ===
1) Add word
2) List all
3) Search
4) Quiz
0) Back

Adding Vocabulary Entries

  1. Choose 3) Manage Vocabulary from the main menu.
  2. Select 1) Add a New Word.
  3. Enter:
    • Source Language (defaults to English if blank).
    • Target Language (defaults to Spanish if blank).
    • Source Term (the word/phrase in the source language).
    • Target Term (its translation in the target language).
    • Explanation (optional).
    • Example usage in a sentence (optional).

Example:

=== Add Vocabulary ===
Source language (blank = English):
Target language (blank = Spanish):
Source term (blank to cancel): Hello
Target term: Hola
Explanation (opt): Simple greeting when you meet someone.
Example (opt): Hello my friend! Holà mi amigo!
Saved.
Press Enter.

Once you entered all elements, you will confirm by pressing "Enter" again and this should display the result "saved" and with another "Enter" you will get back to the section menu and can restart the process for a new word or select another option.

  1. A success message appears once saved.

Viewing and Searching Vocabulary

  • View All: From Manage Vocabulary, select 2) View All Vocabulary Entries. You'll see each term, translation, and any explanation/example.
  • Search: Select 3) Search Vocabulary. Enter a keyword, and the app will find any matching source or target terms.

Taking Vocabulary Quizzes

  1. In Manage Vocabulary, choose 4) Take a Quiz.
  2. Enter how many questions you want (e.g., 5, which is also the default when you just press enter).
  3. The app will pick random vocabulary entries and prompt you to type the translation.
  4. After each question, you'll see if you got it correct and the right answer if not.
  5. At the end, you'll see your score (e.g., 3/5 correct).

(Remark: This can only work, when there are vocabulary entries available and these are not yet considered to be trained. Once you mastered a word, it doesn't reappear for a quiz.)

4) Managing Resources

Menu of this section

=== Resources ===
1) Programming 101 (example course)
2) ... (further courses)
0) Back

(Remark: If no course has been added, this section is blank.)

Adding a Resource

  1. Choose 4) Manage Resources from the main menu.
  2. Select 1) Add Resource.
  3. Pick the course you want to attach the resource to.
  4. Enter the URL and a brief description.
  5. A confirmation message will appear when the resource is saved.

Example:

Resources for Programming 101

1) Add   2) Remove   0) Back
1
URL: www.mycourse.com/program101
Description: Programming 101 Summer 2025

Once saved, you return to the section menu.

Removing a Resource

  1. Choose 4) Manage Resources from the main menu.
  2. Select the resource you want to delete.
  3. The selection is shown and has to be confirmed by pressing enter again.
  4. The URL and description are deleted.

(Remark: The course is deleted in the manage courses and modules section of the main menu (option 1))

5) Managing Quizzes

Adding a Quiz

  1. Choose 5) Manage Quizzes from the main menu.
  2. Select 1) Add Quiz.
  3. Pick the course you want to associate the quiz with.
  4. Enter the quiz title and the due date in the format yyyy-MM-dd.
  5. A confirmation message will appear when the quiz is saved.

Removing a Quiz

  1. Choose 5) Manage Quizzes from the main menu.
  2. Select 2) Remove Quiz.
  3. Pick the course associated with the quiz.
  4. Select the quiz you wish to remove.
  5. Confirm the deletion when prompted.

6) Global Search

  1. Choose 6) Global Search from the main menu.
  2. Enter a keyword to search across all courses, notes, vocabulary entries, and resources.
  3. The app will display a list of matching items categorized by their type.
  4. Select an item to view its details.

7) Progress Dashboard (Summery)

Selecting 7) Progress Dashboard from the main menu displays:

  • Total Courses: Number of courses you've added.
  • Average Course Progress: Average completion percentage across all courses.
  • Total Notes: Total number of notes across all courses.
  • Total Vocabulary Entries: Number of vocabulary entries you've added.
  • Total Resources: Number of resources linked to your courses.
  • Upcoming Quizzes: List of quizzes due soon.

This summary provides a snapshot of your overall learning progress.

8) Exit

This selection shut's the program down and for a restart you will have to rerun dotnet LearningApp.dll from the Terminal.

Troubleshooting & FAQs

  1. App Won’t Launch / CLI Error

  2. SQLite Errors (e.g., “no such table”)

    • The database might be out of sync with the code changes. Consider deleting the old MiaLearning.db file if you can safely lose data, and the app will recreate it upon the next launch.

  3. No Courses Found / No Vocabulary Found

    • You may be running a fresh database with no data. Simply add a course or vocabulary entries from the menu.

  4. Quiz Doesn’t Have Enough Words

    • If you request more quiz questions than available entries, the app will reduce the quiz length to the number of words you have.

  5. Console Beep Not Working

    • Some systems or terminal environments may not support the Console.Beep() function. If you don't hear a beep, consider checking your system settings or using a different terminal.

For additional support, file an issue in the [Issues Section](https://github.com/Ap13Crow/CS690-FinalProject-MiaLearningApp/issues) or contact the developer team.

Enjoy using Mia Learning App! If you encounter any problems or would like new features, feel free to open an issue or pull request on the GitHub repository.

Clone this wiki locally