Simple Bank

📍 About The Project

Simple Bank is a banking application, that mimic the real life banking apps

https://documenter.getpostman.com/view/6225567/2s93JzLfn8 Documentation

https://github.com/users/tobslob/projects/4/views/2?layout=table Project Management

`` Frontend application

`` Backend application

DB MODEL

UML CLASS DIAGRAM

Running locally

To start the application in dev mode, please run:

git clone https://github.com/tobslob/simpleBank.git

cd simpleBank

 yarn install

 add `.env` to root folder, copy the .env.example

 yarn watch

 yarn start:dev

Running using docker compose

Install PostgreSQL on local machine using the following command:

docker pull postgres

## 1. We will create a local folder and mount it as a data volume for our running container to store all the database files in a known location.

mkdir ${HOME}/postgres-data/
## 2. run the postgres image

docker run -d --name dev-postgres \
 --restart=always \
 -e POSTGRES_PASSWORD=secret \
 -e POSTGRES_USER=postgres \
 -e POSTGRES_DB=video-manager \
 -v ${HOME}/postgres-data/:/var/lib/postgresql/data \
 -p 5432:5432 postgres
## 3. check that the container is running
docker ps

 docker compose up

Application is ready to receive connection @ http://localhost:8081

## API Documentation
https://documenter.getpostman.com/view/6225567/2s93JzLfn8

## API-ENDPOINTS

- V1
# USER

`- POST /api/v1/users Create user account`

`- POST /api/v1/users/login Login a user`

# Transfer

`- POST /api/v1/transfers` Create a transfer
# Account

`- POST /api/v1/accounts` Create an account`

`- GET /api/v1/accounts/:account` Get an account`

`- PATCH /api/v1/accounts` Add money

# Entity

`- GET /api/v1/entities` Get all Entities/Transaction history`