codacy-badger/banka_api_ds

A light-weight core banking application that powers banking operations. It is built in Node/Express and uses data structures to store data in memory (No use of a database).

Service	Master	Develop
Travis CI status
Coveralls

Banka_API

API for the Banka app. A light-weight core banking application that powers banking operations. It is built in Node/Express and uses data structures to store data in memory (No use of a database).

Hosted Apps

• Banka UI
• Banka API

Requirements

• Node Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.

Getting Started

In your terminal

1. Clone the repo locally to your machine by running git clone https://github.com/DrKimpatrick/Banka_API.git
2. change your current directory (cd) to wherever you cloned the app in 1 above.

Development setup

• Install dependencies

  npm install

Run the application

node index

Running tests

npm test

API REST End Points

End Point	Verb	Use
/api/v1/auth/signup	POST	Create user account
/api/v1/auth/login	POST	User login
/api/v1/account	POST	Create Bank account
/api/v1/status/:accountNumber	PATCH	Updates account status by staff/admin
/api/v1/transactions/:accountNumber/credit	POST	Credits a bank account by a staff
/api/v1/transactions/:accountNumber/debit	POST	Debits a bank account by staff
/api/v1/status/:accountNumber	DELETE	Deletes a bank account
/api/v1/account/history	GET	Gets user account transaction history
/api/v1/users	GET	Retrieves all user accounts

Built With

• Express A minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications

Acknowledgments

A Special thanks goes to

1. Andela for having given me an opportunity to participate in the boot camp, without them , this application wouldn't have existed