CICD_Java_Backend_Personal_Library/README.md

Personal Library Manager API

This API is designed to help you list all your books.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

This API helps you to manage your books. You can add new ones, list yours, loan or borrow some others.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Java (version >= 17)
• Maven (version == 3.8.4)
• MongoDB (version == 7)
• Postgres (version == 14)
• IntelliJ Ultimate Edition to use included tests files

Local Installation

1. Clone the repo

   git clone TODO
   

2. Create a local .env file at your project root and fill these variables

    MONGODB_CONNECTION_STRING=<TO_FILL>
    MONGODB_DATABASE_NAME=<TO_FILL>
    PG_USERNAME=<TO_FILL>
    PG_PASSWORD=<TO_FILL>
    PG_HOST=<TO_FILL>
   

3. Build a local version of the application

   mvn clean package
   

   It will generate your compiled application into target/quarkus-app directory and your Swagger documentation files into the swagger directory.
4. Run tests locally and publish sonar reports

   mvn verify sonar:sonar
   

(back to top)

Usage

For more examples, please refer to the Swagger Documentation

(back to top)