danieltex / faerun-app

API for controlling Faerun water pocket loans

Faerun Balance

An API to manage water pockets storage and loans between them

Table of Contents

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

About The Project

Built With

• Gradle and Kotlin DSL
• Spring Boot 2.5.1
• SpringDoc OpenAPI
• JDK 11
• Kotlin 1.5
• MySQL 8.0
• H2 Database (for integration testing)
• Docker
• JaCoCo 0.8.7
• Codecov for code coverage reports triggered by Github Actions
• Mockito-Kotlin

Getting Started

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

Installation

1. Clone the repo

   git clone https://github.com/danieltex/faerun-app.git

2. Install Java JDK 11+

   Follow the installation guide for your OS at Overview of JDK Installation

Usage

Run the full application through docker-compose:

1. Building the source

   ./gradlew clean build

2. Build the docker image:

   docker build -t faerunapp .

3. Running

   Start the database and app with docker compose:

   docker-compose up

Run the database with docker-compose and start the application manually:

1. Start the database

   docker-compose up db

2. Build and run the application with gradle or start the FaerunAppApplicationKt class through your IDE of preference

   ./gradlew bootRun

The application will start on the port 5000

Examples

1. Create a new water pocket

curl --location --request POST 'http://localhost:5000/water-pockets' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "name": "Itaipu",
    "storage": 62200000.0
}'

Response:

{
    "name": "Itaipu",
    "storage": 62200000.0,
    "id": 1
}

More examples can be seen at the API Documentation at http://localhost:5000/swagger-ui.html

Contact

Daniel Teixeira dos Santos

Project Link: https://github.com/danieltex/faerun-app