FakeBank

Overview

FakeBank is a sample banking application built with Spring Boot, Java, and Maven. It provides a set of RESTful APIs for managing bank accounts and processing payments.

Table of Contents

• Overview
• Features
• Getting Started
  • Prerequisites
  • Installation
  • Running the Application
• Configuration
• API Documentation
• Testing
• License

Features

• Manage bank accounts
• Process payments
• RESTful APIs
• Docker support
• Continuous Integration with GitHub Actions
• Code quality checks with CodeQL

Getting Started

Prerequisites

• Java 17 or higher
• Maven 3.6.0 or higher
• Docker

Installation

Clone the repository:

git clone https://github.com/ianrobrien/fakebank.git
cd fakebank

Running the Application

Build and run the application using Docker Compose:

docker compose build
docker compose up fakebank

Configuration

Configuration files are located in the src/main/resources directory:

• application.properties
• application-local.properties
• application-dev.properties

API Documentation

To see a complete specification, check the API summary or the YAML spec.

Testing

Run the tests using Maven:

mvn test

License

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