A light-weight core banking application.

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..

• Technologies
• API Endpoints
• Features
• Getting Started
  • Installation
  • Developing
  • Licensing

Pivotal Tracker was used in managing this project and you can find all the stories by clicking the link below https://www.pivotaltracker.com/n/projects/2320369

UI templates is hosted at https://chuxmykel.github.io/banka/UI/index.html

• NodeJs - Runtime Environment
• Express - Web Application Framework

• ESlint - Linter Tool

• Babel - Compiler for Next Generation Javascript

• Mocha - JavaScript Test Framework for+ API Tests
• Chai - TDD/BDD Assertion Library

Visit https://a-bank.herokuapp.com/api/v1/docs to view API Documentation

• User (client) can sign up
• User (client) can login
• User (client) can create an account
• Staff (cashier) can debit user (client) account
• Staff (cashier) can credit user (client) account
• Admin/staff can activate or deactivate an account
• Admin/staff can delete a specific user account
• Integrate real time email notification upon credit/debit transaction on user account

To run this application, you need to have Node.js, and git(to clone the repo) installed. Then follow the instructions to get it up and running

• clone the repo using

~> git clone https://github.com/chuxmykel/banka.git

• run npm install --prod to install dependencies
• create a .env file from the .env.example file and fill in the necessary environment variables
• run npm run build to build the project and then run npm start to start the server
• now access the server on the localhost port 5000 i.e localhost:5000 or 127.0.0.1:5000

Now the server will go live and listen for requests

To develop the app further, a few handy tools have been put in place such as nodemon and some other dev dependencies. Access them by starting the server using npm run dev. But before using the command, make sure to follow the steps below

git clone https://github.com/chuxmykel/banka.git
cd banka/
npm install
npm run dev

The app is written in ES6+ and wired to run ES5 transpiled code in production. To transpile any changes to ES5 run the script shown below

npm run build

Babel then transpiles your ES6+ files to ES5 for environment compatibility

Copyright © 2019, Ngwobia, Chukwudi M. The code in this project is licensed under ISC LICENSE