spafi / trade-finance-be

Trade Mediator API

A REST API for a simple platform that supports importers and exporters to communicate with each other, using a bank as intermediary.

Relevant Links

Data Model

API GitHub Repository

Angular Client GitHub Repository

Getting started

Prerequisites

JDK 17+

Gradle

PostgreSQL 15.3

Running the application locally

1. Create a PostgreSQL database
2. Copy the contents of .env.example file to a .env file and update the necessary fields with your configuration.

To insert mock data in the database, set the INSERT_MOCK_DATA variable to true

3. Build & Run the application
4. Access the application using http://localhost:8080/ *
5. OpenApi Documentation is available at http://localhost:8080/swagger-ui.html *

• * Replace 8080 with your updated port if you're not using the default one