Banka is a light-weight core banking application that powers banking operations like account creation, customer deposit and withdrawals.
UI template: (https://olayinkaraheem.github.io/banka/)
API Link (https://app-banka.herokuapp.com)
Pivotal Tracker Link (https://www.pivotaltracker.com/n/projects/2320535)
-
Download and install Node.js
-
Clone project
> git clone https://github.com/olayinkaraheem/banka.git
- Install Dependencies
> npm install
- Run project
> npm start
- Client/User can sign up.
- Client/User can login.
- Client/User can create a bank account.
- Cashier/Staff can debit a user's bank account.
- Cashier/Staff can credit user (client) account.
- Admin/Staff can activate or deactivate an account.
- Admin/Staff can delete an account.
Description | HTTP Method | Endpoints |
---|---|---|
Sign up User | POST | /api/v1/auth/signup |
Log in User | POST | /api/v1/auth/signin |
Create a bank account | POST | /api/v1/accounts |
Activate a bank account | PATCH | /api/v1/accounts/account-number |
Deactivate a bank account | PATCH | /api/v1/accounts/{account-number} |
Delete a bank account | DELETE | /api/v1/accounts/{account-number} |
Credit a bank account | POST | /api/v1/transactions/account-number/credit |
Debit a bank account | POST | /api/v1/transactions/account-number/debit |
{
"email": "user2@mail.com",
"firstName": "Smith",
"lastName": "Rex",
"password": "userpass@421",
"type": "client",
"isAdmin": false,
"created_at": "2019-04-07 07:00:43",
"updated_at": ""
}
{
"email": "admin@banka.com",
"password": "adminpass@421"
}
{
"owner": 3,
"type": "current"
}
{
"userId": 1,
"status": "dormant"
}
{
"userId": 1,
"status": "active"
}
{
"userId": 1,
"status": "deleted"
}
{
"amount": "3000.00",
"cashier": 2,
"type": "debit"
}
{
"amount": "5000.00",
"cashier": 2,
"type": "credit"
}
Account number: 1233445642
© Olayinka Raheem