Skip to content

misanj/bankaApp

Repository files navigation

bankaApp

Build Status Coverage Status Maintainability Test Coverage

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

Installing / Getting started

Running this application, you'll need to have Node.js and git version control installed to clone the repo. Then follow the instructions....

  • clone the repo using
https://github.com/misanj/bankaApp.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 5200 i.e localhost:5000 or 127.0.0.1:5000

Now the server will go live and listen for requests

Developing

To futher develop this app, a few handy tools nodemon, debug and some other dev dependencies have been put inplace to enable a smooth run, You can 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/misanj/bankaApp.git
cd bankaApp/
npm install
npm run dev

Building

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

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
  • Integrate real time email notification upon credit/debit transaction on user account
  • User can upload a photo to their profile. 

Links

Licensing

Copyright (C) Misanj Temisan Otokuefor "The code in this project is licensed under ISC LICENSE"

About

Heroku : https://ba-nka.herokuapp.com/

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published