Skip to content

Latest commit

 

History

History
145 lines (98 loc) · 4.02 KB

README.md

File metadata and controls

145 lines (98 loc) · 4.02 KB
Raw

Trivia

License Java Spring Boot MongoDB Postgres Swagger

Trivia is a Spring Boot application designed to manage trivia questions across various programming languages. It integrates MongoDB for data storage and exposes a RESTful API to manage questions. Additionally, it leverages Swagger to document the API and provide an interactive UI for testing the endpoints.

Features

  • Question Management: Add, update, and delete trivia questions for multiple programming languages.
  • Report Management: Mark trivia questions as resolved or unresolved based on reports.
  • Difficulty Levels: Categorize questions by difficulty (Easy, Medium, Hard).
  • Random Selection: Fetch random questions based on difficulty.
  • Swagger Integration: Provides API documentation and an interactive interface for testing.
  • Exception Handling: Custom error handling for invalid inputs and rate-limiting.

Table of Contents

Technologies Used

  • Java 17
  • Spring Boot 3.3.3
  • MongoDB for the database.
  • Postgres for second database.
  • Swagger for API documentation.
  • Lombok for reducing boilerplate code.
  • Maven for project management and build automation.
  • Jackson for JSON processing.

Getting Started

To get a copy of the project running on your local machine, follow the steps below.

Prerequisites

  • Java 17 or higher.
  • Maven for building the project.
  • MongoDB for the database.

Installation

  1. Clone the repository:

    git clone https://github.com/Skill-Forge-Project/skill_forge_trivia.git
cd skill_forge_trivia

  2. Install dependencies:

    mvn clean install

  3. Set up MongoDB:

    Ensure MongoDB is running locally, or update the connection string in application.properties or application.yml with your MongoDB instance details.

  4. Create application-env.properties in main directory with the Postgres username and password.

Running the Application

You can run the application using the following methods:

  • Using Maven:

    mvn spring-boot:run

  • Using the JAR file:

    java -jar target/Trivia-0.0.1-SNAPSHOT.jar

API Endpoints

Here are some key API endpoints:

  • Get Random Questions:

    GET /trivia/{language}/{difficulty}

  • Add a New Question:

    POST /trivia/questions/{language}/{difficulty}

  • Update a Question:

    PUT /trivia/questions/{language}/{id}

  • Delete a Question:

    DELETE /trivia/questions/{language}/{id}

  • Mark a Reported Question as Resolved:

    PUT /trivia/reports/{id}/resolve

Replace {language} with java, csharp, javascript, or python. Replace {difficulty} with Easy, Medium, or Hard.

Swagger Documentation

Swagger provides an interactive interface for testing the API. Once the application is running, visit:

http://localhost:8080/swagger-ui.html

Contributing

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Commit your changes and push to your fork.
  4. Submit a pull request with a detailed description of your changes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.