Giter Club home page Giter Club logo

bankerr's Introduction

Bankerr

This is a sample project for a Bank Account API built using Spring Boot and Axon Framework.

Getting Started

Perequisites

  • Java 11 or later
  • Maven 3.6 or later

Building the Project

To build the project, run the following command in the root directory of the project:

mvn clean install 

Running the Application

To run the application, you can use the following command:

mvn spring-boot:run

This will start the application on port 8080 by default. You can access the API documentation by visiting http://localhost:8080/swagger-ui.html in your browser.

Running Tests

To run the test, use the followung command:

mvn test 

API Endpoints

THe following API endpoints are available: ###Create an Account POST/ accounts Create a new bank account

Request Body:

{
  "customerId": "string"
}

Credit an Account

POST /accounts/{accountId}/credit

Credit the specified bank account.

Path Variables:

accountId: The ID of the account to credit. Request Body:

{
  "amount": 0
}

Debit an Account

POST /accounts/{accountId}/debit

Debit the specified bank account.

Path Variables:

accountId: The ID of the account to debit. Request Body:

{
  "amount": 0
}

Built With

  • Spring Boot - Web framework for building RESTful APIs
  • Axon Framework - CQRS and event sourcing framework
  • Swagger - API documentation tool

Authors

Praise Freedom Dike

License

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

bankerr's People

Contributors

freedompraise avatar

Stargazers

Marek Sagan avatar

Watchers

Marek Sagan avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.