aybruhm / fastapi-ledger-system

Have you ever been curious as to how fintech applications are built? This system demonstrates the basic functionalities of a fintech product.

FastAPI-Ledger

Have you ever been curious as to how fintech applications are built? This system demonstrates the basic functionalities of a fintech product.

Technologies

• FastAPI
• PostgreSQL
• SQLAlchemy (ORM)
• Docker and Docker-compose
• Alembic (Database migrations)
• Pytest (Unit testing)

Problem Statement

Build a ledger system with the following functionalities:

• ( Deposit Money ) Credit X amount to one of the user’s account
• ( Withdraw Money ) Debit X amount from one of the user’s account
• Transfer money from one account to another account for a single user
• Transfer money from one account of one user to another user
• Get balance for a user
• Get balance for an account of a user
• User can have (10) maximum wallets

Getting Started

To get the service up and running, follow the steps below:

1). Run the commands below in your terminal:

git clone [e-mail]:aybruhm/fastapi-ledger-system.git

2). Change directory to fastapi-ledger-system:

cd fastapi-ledger-system

3). Rename the .env.template file to .env and update the values.

4). Build and run the service with:

docker-compose up --build

The service will build and run on port 8080.

5). Launch a new terminal session and run the following commands:

chmod +x run-migrations.sh

./run-migrations.sh

The above commands would activate the script file and when ran- will make database migrations for you automatically.