Banka

Banka is a light-weight core banking application that powers banking operations like account creation, customer deposit and withdrawals. This app is meant to support a single bank, where users can signup and create bank accounts online, but must visit the branch to withdraw or deposit money.

---

Features

• User (client) can sign up
• User (client) can login
• User (client) can create an account
• User (client) can view account transaction history
• User (client) can view a specific account transaction
• User (client) can transafer fund to other account owners
• Staff (cashier) can debit user (client) account
• Staff (cashier) can credit user (client) account
• Admin/staff can view all user accounts
• Admin/staff can view a specific user account
• Admin/staff can activate or deactivate an account
• Admin/staff can delete a specific user account
• Admin can create staff and admin user accounts
• Users can change password

---

Management

The project development is managed on [Pivotal tracker] https://www.pivotaltracker.com/n/projects/2321662

---

Frontend

The UI is hosted on [Github pages] https://halimaho.github.io/Banka/UI/

---

Backend

The api is hosted on [Heroku] https://my-banka-app.herokuapp.com/api/v1/

---

Technologies Used

• [Node.js]
• [Express.js]
• [ESLint]

---

Testing Tools

• [Mocha]
• [Chai]
• [NYC]
• [Postman]

---

API Information

The API is hosted on [Heroku] https://my-banka-app.herokuapp.com/api/v1/

METHOD	RESOURCE	DESCRIPTION	ENDPOINTS
GET	----	Home page	/api/v1
POST	Account	Create an account	/api/v1/accounts
PATCH	Account	Activate/deactivate an account	/api/v1/accounts/:accountNo
DELETE	Account	Delete an account	/api/v1/accounts/:accountNo
GET	Account	Get a specific account	/api/v1/accounts/:accountNo
GET	Account	Get all accounts	/api/v1/accounts/
GET	Account	Get all active accounts	/api/v1/accounts?status=active
GET	Account	Get all dormant accounts	/api/v1/accounts?status=dormant
GET	Account	Get account transaction history	/api/v1/accounts/:accountNo/transactions
POST	User	User signup	/api/v1/auth/signup
POST	User	User signin	/api/v1/auth/signin
POST	User	Create staff	/api/v1/staff
GET	User	Get all user accounts	/api/v1/user/:email/accounts
POST	Transaction	Debit account	/api/v1/transactions/:accountNo/debit
POST	Transaction	Credit account	/api/v1/transactions/:accountNo/credit
GET	Transaction	Get specific transaction	/api/v1/transactions/:transactionId

---

Clone

• Clone this repo to your local machine using https://github.com/halimahO/Banka.git

Setup

• Installing the project's dependencies:

run the command below

$ npm install

To start the server, run the command below

$ npm startDev

---

Test

• To test the app

run test using the command below

$ npm test

---

Acknowledgements

Andela

---

Author

Halimah Oladosu

Contributors

LOS2-Team2