Skip to content
/ Banka Public

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.

License

Notifications You must be signed in to change notification settings

OvieMudi/Banka

Repository files navigation

Banka

A light-weight core banking application.

Build Status Coverage Status Code Climate Reviewed by Hound

Introduction

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.

Getting Started

Prerequisite

Install NodeJs

Installation

To get this application running on your local computer, run the following commands.

# Clone this repository
$ git clone https://github.com/OvieMudi/Banka.git

# Navigate to application folder
$ cd Banka

# Install dependencies
$ npm install

# Create .env file in your root directory to store your environment variables
# .env file content must include DATABASE_URL and SECRET_STRING

# Run the app
$ npm start

Tests

Banka uses the Mocha test framework and Chai assertion library NodeJs to run automated unit tests on all endpoints.

Runnig the tests

npm run test

Deployment

Baka API endpoints are deployed on Heroku. View the docs here.

The UI page pages are deployed to GitHub Pages. Check it out.

Technology Stack

  • ES6 Javascript (Airbnb style guide)
  • Nodejs (Express framework)
  • Compiled with Babel
  • HTML (UI templates)
  • CSS

Testing tools

  • Mocha (Test Framework)
  • Chai (Assertion Library)
  • Istanbul (code instrumenter)
  • NYC (Istanbul's command line interface)
  • Postman (Manual Testing of API endpoints)

Authors

Ovie Udih

Collaborators

Shine

Stakeholders

About

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.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published