Quiz-app-Backend: Hubro

Hubro is a full-stack application developed with Spring Boot and Vue.js. The application is developed as part of an assessment in the subject IDATT2105 Full-stack application development at NTNU.

Team

• Ramtin Forouzandehjoo Samavat
• Tobias Skipevåg Oftedal
• Jeffrey Yaw Annor Tabiri

Table of Contents

• Overview
• Wiki
• Features
• Setup and Run
• Acknowledgements

Overview

The semester project is a full-stack web application aiming to provide a comprehensive and user-friendly platform for creating, managing, and taking quizzes for educational, training, or entertainment purposes.

The project utilizes the following technologies:

• Frontend: Vue.js with Node.js.
• Backend: Spring Boot V3 with Java 21 and Maven.
• Database: MySQL V8 for runtime and H2 for tests.

Wiki

These are system documents which descirves the various aspects of a software system. These documents capture the details of the system's design, implementation, operation and maintenance, serving as a reference for developers.

• System Architecture Program
• Class Diagram
• Sequence diagram for getting quiz
• Sequence diagram for login user

Features

• Secure Authentication: Users can securely log in, register, and manage their accounts.
• Quiz Creation: Authenticated users can create quizzes by adding questions and specifying categories.
• Question Tagging: Users can tag questions with keywords and categorize them into topics or subjects.
• Advanced Search: Users can search for quizzes and filter them based on various criteria.
• Quiz Management: Users have full control over their quizzes, including adding, editing, deleting, and organizing them.
• Progress Tracking: Users can track their progress and scores for each quiz they take.
• Feedback Channel: Users can easily reach out to us with any issues or feedback through our feedback channel.

Setup and Run

Prerequisites

• JDK 21
• Maven installed on device
• A maven management tool
• Docker

Set up and run the backend.

1. Begin by cloning the project into your device. In your terminal, enter following command:

   git clone https://github.com/RamtinS/quiz-app-backend.git
   

2. Navigate to the project directory by typing the following command in the terminal:

   cd quiz-app-backend
   

   This command will start the database required for the backend to function.

3. Navigate to the docker file by running this command in the terminal:

   cd docker
   

4. Run the database by starting the docker compose file in the terminal with this command.

   docker-compose up
   

5. Find a new terminal and enter the following command to finally start the backend.

   ./mvnw spring-boot:run
   

Other commands

You can run the program with, or without test data by modifying the command in line 6

• To run with a test file, use this command:

  ./mvnw spring-boot:run -Dspring-boot.run.arguments=--deleteAllData
  

• To run without a test file, use this command:

  ./mvnw spring-boot:run -Dspring-boot.run.arguments=--noTestData
  

Test

To run the tests, you would use the command

This command will execute all the tests in the project.

Acknowledgements

Special thanks to the subject teachers for creating this assignment and providing us with the opportunity to develop this project.