Dev Apologies Generate

A backend application which will generate random apologies for a developer

Dev Apologies Randomizer

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

You are a developer and a customer is asking you something?
Here is the random apologies generator you need to make him waiting !

(back to top)

Built With

• Java 17
• Maven
• Docker
• Postgres

(back to top)

Getting Started

Prerequisites

To run the project, you will need :

• Java 17
• Maven
• Docker

Installation

1. Clone the repo

   git clone https://github.com/qloots/dev-apologies-randomizer.git

2. Open it in your favorite IDE
3. Build the PostgreSQL Docker image

   docker compose up -d

4. Run the DevApologiesRandomizerApplication via your IDE
5. Enjoy it with Postman in a first time

(back to top)

Usage

Get all apologies

GET http://localhost:8080/api/apologies will return you all the available apologies.

Get a random apology

GET http://localhost:8080/api/apologies/random will return you a random apology t give to your customer.

Add an apology

POST http://localhost:8080/api/apologies will add an apology into the database.

(back to top)

Stop the project

1. Stop the running application from your IDE.
2. Shut down the dockerized PostgreSQL:

   docker compose down

3. Delete all containers:

   docker rm -f $(docker ps -a -q)

4. Delete all volumes:

   docker volume rm $(docker volume ls -q)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some Amazing Feature')
4. Push to the Branch (git push origin feat/AmazingFeature)
5. Open a Pull Request

(back to top)