Giter Club home page Giter Club logo

banka's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.