shonubijerry/quick-credit


Loan application

License: MIT

Language: HTML

Keywords: api, application, express, loan, nodejs


Quick-Credit

Build Status Test Coverage Maintainability Coverage Status License: MIT

Quick Credit is an online lending platform that provides short term soft loans to individuals. This helps solve problems of financial inclusion as a way to alleviate poverty and empower low income earners.

UI hosted on gh pages

https://shonubijerry.github.io/quick-credit/UI/

Working frontend hosted on gh pages

https://shonubijerry.github.io/quick-credit-frontend/

Pivotal Tracker Project

https://www.pivotaltracker.com/n/projects/2326551

Server side hosted on Heroku

https://quick-credit-shonubi.herokuapp.com/

API Documentation

https://quick-credit-shonubi.herokuapp.com/api-docs

https://quickcredit6.docs.apiary.io/

Table of Content

Getting Started

Prerequisites for installation

  1. Node js
  2. Express
  3. Git

Installation

  1. Clone this repository into your local machine:
e.g git clone https://github.com/shonubijerry/quick-credit
  1. Install dependencies
e.g npm install.
  1. Start the application by running the start script.
e.g npm start
  1. Install postman to test all endpoints on port 3000.

Run Test

e.g npm test

API End Points Test Using Postman

HTTP VERB ENDPOINT FUNCTIONALITY
POST /api/v1/auth/signup User signup
POST /api/v1/auth/login User signin
POST /api/v1/loans Post a loan
POST /api/v1/loans/:loanId/repayment Posts a loan repayment
PATCH /api/v1/users/:email/verify Verify a user
PATCH /api/v1/loans/:loanId Approve/Reject a loan repayment
GET /api/v1/loans Get loans
GET /api/v1/loans/:loanId Get a loan by loanId
GET /api/v1/loans?status=approved&repaid=false Get all current loans
GET /api/v1/loans?status=approved&repaid=true Get all repaid loans
GET /api/v1/loans/:loanId/repayments Gets repayments for a loan
GET /api/v1/users Gets all users

Coding Style

  • Airbnb style guide.

Features

Users

  • A user can sign up
  • A user can login
  • A user can request for loan
  • A user can view loan repayment history

Admin

  • Admin can mark a client as verified
  • Admin can view a specific loan application
  • Admin can approve or reject a client’s loan application
  • Admin can post loan repayment transaction in favour of a client
  • Admin can view all loan applications
  • Admin can view all current loans (not fully repaid)
  • Admin can view all repaid loans
  • Admin can view all users

Built With

  • NodeJs-EXPRESS: Node.js is a javascript runtime built on Chrome's V8 javascript engine.

  • html5: It is used for structuring the frontend.

  • css: It is used for styling the frontend.

Author

  • Shonubi Oluwakorede

License

This project is licensed under The MIT License (MIT) - see the LICENSE.md file for details.

Acknowledgement

  • Andela

Project Statistics

Sourcerank 3
Repository Size 740 KB
Stars 1
Forks 0
Watchers 0
Open issues 1
Dependencies 29
Contributors 2
Tags 0
Created
Last updated
Last pushed

Top Contributors See all

Shonubi Oluwakorede korey1020

Something wrong with this page? Make a suggestion

Last synced: 2019-10-23 09:53:57 UTC

Login to resync this repository