Code Monkey home page Code Monkey logo

banka's Introduction

Build Status Coverage Status Maintainability Test Coverage

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

Prerequisites

To run this application, you should have the following:

  • Node
  • NPM/Yarn (NPM comes with Node)

Installation

Follow the instructions to have the app up and run:

  • clone the repo: RUN THE COMMAND
>> git clone https://github.com/PelumiAlesh/Banka.git
  • Install the production depency: RUN THE COMMAND
>> npm i --prod
  • Transpile the code: RUN THE COMMAND
>> npm run build
  • Start the server: RUN THE COMMAND
>> npm run start
  • You should use localhost:5000 as your base url

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.
  • 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.
  • User can reset password.
  • User can upload a photo to their profile.

Running the test

To run the test USE the following command

>> npm run test

What does this test covers?

The test covers all the endpoints and requests sent to them.

Deployments

This application was deployed to the following:

API Endpoints

METHOD DESCRIPTION ENDPOINTS
POST User's Sign up /api/v1/auth/signup
POST User's Sign in /api/v1/auth/signin
POST Create a bank account /api/v1/accounts
PATCH Activate or deactive an account /api/v1/accounts/:accountNumber
DELETE Delete an account /api/v1/accounts/:accountNumber
POST Perform a debit transaction /api/v1/transactions/:accountNumber/debit
POST Perform a credit transaction /api/v1/transactions/:accountNumber/credit

Acknowledgments

Andela

banka's People

Contributors

pelumialesh avatar

Watchers

James Cloos avatar

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.