QUIZ APPLICATION

• Welcome to the Quiz Application, a comprehensive platform designed to test your knowledge across three categories: Java, Operating Systems (OS), and C programming.
  
• This application features a robust login-signup system, a versatile question service for managing questions, and a dynamic quiz service that leverages the question service to generate quizzes, calculate scores, and more.
  
• It is a robust quiz platform built with Java, utilizing Spring Boot and Spring Cloud for a microservices architecture.

GETTING STARTED

Prerequisites:

• Java Development Kit (JDK) 8 or higher
• MySQL
• IntelliJ IDEA (or any Java IDE)
• Postman (for API testing)

SERVICES ORDER AND OVERVIEW

1. service-registry-server (if there's a config server then first config server then service-registry-server(Eureka Discovery Service) )
2. AppGateway ( API Gateway )
3. login-signup ( micro-service 1 )
4. question-service-ms ( micro-service 2 )
5. quiz-service-ms ( micro-service 3 )

Service Registry Server (Eureka Discovery Service):

• The service registry server is responsible for service discovery within the microservices architecture. It allows services to find and communicate with each other.

AppGateway (API Gateway):

• The AppGateway acts as the single entry point for all client requests, routing them to the appropriate microservices.

Login-Signup Service:

• This service handles user authentication and registration. It provides endpoints for creating a new user, logging in, and managing user sessions.

Question Service:

• The Question Service is the backbone of the application, managing all aspects of questions. It allows for adding, retrieving, updating, and deleting questions. It also supports fetching questions by category and calculating scores.

Quiz Service:

• The Quiz Service leverages the Question Service to generate quizzes based on user preferences. It provides endpoints for creating quizzes, retrieving quizzes, and calculating scores.

API DOCUMENTATION

Detailed API documentation for each service is provided below. This includes endpoints, request formats, and response examples.

1. Login-Signup Service:

To create a new user i.e sign up -
POST> - http://localhost:8083/users-ws/users
Ex.

{
    "firstName": "My",
    "lastName" : "Account",
    "password" : "555666777888",
    "email" : "MytestAccount2024@gmail.com"
}

To login- POST> - http://localhost:8083/users-ws/users/login Ex.

{
    "email" : "MytestAccount2024@gmail.com",
    "password" : "555666777888"
}

It won't show anything , it Will give the STATUS:200 OK
To match it I can always match the userId.

After login to make sure I can always match the generated user id (public user id i.e an alphanumeric id) in the databse to the userId in the Headers.

2. Question Service:

To get all questions- GET> - http://localhost:8083/question-service/question/allquestions

To get the questions of a particular category-
GET - /question-service/question/category/{category}
GET> - http://localhost:8083/question-service/question/category/c
GET> - http://localhost:8083/question-service/question/category/os
GET> - http://localhost:8083/question-service/question/category/java

To post a question(add a question to DB)

POST> - http://localhost:8083/question-service/question/add

Ex.

{
    "category": "Java",
    "question": "What created Java?",
    "option_1": "A. Bjarne",
    "option_2": "B. Bill Gates",
    "option_3": "C. Elon",
    "option_4": "D. James Gosling",
    "correct_ANSWER": "D. James Gosling",
    "difficulty_LEVEL": "Easy"
}

To update a question in the DB-
PUT - /question-service/question/update/{category}/{id}

PUT> - http://localhost:8083/question-service/question/update/java/121

Ex.

{
    "category": "Java",
    "question": "What created Java?",
    "option_1": "A. Bjarne",
    "option_2": "B. Bill Gates",
    "option_3": "C. Elon",
    "option_4": "D. no one",
    "correct_ANSWER": "D. no one",
    "difficulty_LEVEL": "Easy"
}

To delete a question in the DB
DELETE - /question-service/question/delete/{id}

DELETE> - http://localhost:8083/question-service/question/delete/121

(I can use the other requests as well but since the quiz service will be hitting them anyways , I'll use the quiz service for that )

3. Quiz Service:

**To create a quiz of a particular topic with the number of questions I want ** POST> - http://localhost:8083/quiz-service/quiz/create

Ex.

{
    "category": "C",
    "numOfQ" : "5",
    "title" : "This-Is-My-C-Test"
}

To get the quiz I generated I need to retrieve it with its id-
GET - /quiz-service/quiz/get/{id}

GET> - http://localhost:8083/quiz-service/quiz/get/38

With that I'll get the quiz named: This-Is-My-C-Test , which has 5 C topic questions.

• Oh and If I want to get the questions of particular ids in question service , I've to use -
  POST> - http://localhost:8083/question-service/question/getQuestions
  And need to pass the ids in this form - [51, 72, 64, 57, 46] , as it expects a list of Integers.

To get the score -
POST - /quiz-service/quiz/submit/{id}
POST>-http://localhost:8083/quiz-service/quiz/submit/37

For this I need to give the id and my responses.

Ex.

[
    {
    "id": 48,
    "response":"// This is a comment"
    },

    {
    "id": 58,
    "response": "11"
    },

    {
    "id": 63,
    "response": "4 3 2 1 0"
    },
 
    {
    "id": 76,
    "response": "!"
    },
    
    {
    "id": 78,
    "response":"Perform assertions in testing"
}
]

TECHNOLOGIES USED

• Spring Boot: For building the microservices.
• MySQL: As the database for storing questions and user data.
• JDBC: For direct database access, providing a deeper understanding of database communication.
• Feign: As a declarative web service client, simplifying communication between microservices.
• IntelliJ IDEA: As the IDE for development.
• Postman: For testing the API endpoints.

CONTACT

For any questions, feedback, or contributions, please feel free to reach out.
You can contact me through- Email: anukulmaurya18@gmail.com

---

While this project was inspired by a short tutorial, it has been significantly expanded and refined with my own work.