Git Product home page Git Product logo

banka's Introduction

Logo of the project

BANKA

Bank with Banka today

A light-weight core banking application that manage all bank account operations. A bank that is readily available to you anywhere you go. Allows you to perform most banking activities, view previous banking transactions, know the state of you financies anywhere you are.

Developing

After cloning the repository, open the server directory in the banka app before installing package manager:

git clone https://github.com/henryade/Banka.git
cd Banka/server
npm install
  • clone repository
  • cd Banka/server
  • npm install
  • start editing...
  • Use postman to test all endpoints

Badges

Build Status

Features

Route Testing prefix = localhost:(portname)api/v1


A User can solely perform the following functionalities:

Functionalities Route Testing
Sign up for an account POST /auth/signup
Sign into created account POST /auth/signin
Create a bank account POST /accounts
View previous account transactions GET /accounts/:account-number/transactions
View a specific account transaction GET /transactions/:transaction-id

A Staff can solely perform the following functionalities:

Functionalities Route Testing
Credit a user account POST /transactions/:account-number/credit
Debit a user account POST /transactions/:account-number/debit

An/A Admin/Staff has the shared access of performing the following functionalities:

Functionalities Route Testing
View a list of all bank accounts GET /accounts
View all active user account GET /accounts?status=active
View all dormant user account GET /accounts?status=dormant
View accounts owned by a specific user GET /user/:user-email-address/accounts
View a specific user account GET /accounts/:account-number
Delete a specific user account DELETE /accounts/:account-number
Activate a user account PATCH /accounts/:account-number
Deactivate a user account PATCH /accounts/:account-number

An Admin can solely perform the following

Functionalities Route Testing
Create a staff account POST /user
Create an admin account POST /user

Configuration

The build is run locally. To run build, copy the contents of the .babelrc file in the build folder and use it to replace the contents of the .babelrc file in the server folder. .babelrc in build folder

{
    "presets": ["env"],
    "plugins": ["transform-object-rest-spread"]
}

Then run the build command in the scripts section below from the server repository. After the command is done, undo the copy to get the initial contents of the .babelrc file in the server. OR paste this

{
    "presets": ["@babel/preset-env"],
}

in the file.

Scripts:

npm run dev   ------ To run app in development
npm run test-dev --- To run development testing

npm run build ------ To build production folder
npm test ----------- To test production ready app
npm start -----------To run production ready app

Technologies Used

  • Nodejs
  • Express
  • joi - validation
  • Eslint - airbnb style
  • Babel

Links

Project links:

Licensing

"The code in this project is licensed under ADC Licence."

banka's People

Contributors

henryade avatar ad3ola 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.