Quick-Credit

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

Table of Contents

• Introduction
• UI Templates
• API
• API Documentation
• Pivotal Tracker ID
• Technologies
• Installing
• Working Routes
• License

Introduction

Project Overview

Quick Credit is an online lending platform that provides short term soft loans to individuals earning low-income. Loans are provided instantly upon administrator approval.

Style guide

Airbnb (Javascript style guide)

Screenshot(UI template)

UI Templates

Preview UI templates 👍 Github Pages

API

The API is currently in version 1 (v1) and is hosted at https://quick-credit-loan.herokuapp.com

API-Documentation

The API endpoints are documented using swagger.json and can be accessed here API-Docs

Pivotal Tracker ID

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

Required Features

• Users can sign up.
• Users can login.
• User can apply for loan.
• User can view loan repayment history.
• Admin can mark user as verified`.
• Admin can view all loan applications
• Admin can view a specific loan application
• Admin can view current loans (not fully repaid)
• Admin can view all repaid loans
• Admin can approve or reject a client's loan application
• Admin can post loan repayment transaction in favour of client

Technologies

• NodeJs
• Express
• Mocha & Chai
• ESLint
• Babel
• Travis
• Code Climate
• Coveralls

Installing

Prerequisites

Ensure you have NodeJS installed by entering node -v on your terminal If you don't have NodeJS installed, go to the NodeJS Website, and follow the download instructions

To install this app

git clone https://github.com/mekzy-o/Quick-Credit

And install the required dependencies

npm install

Run server

npm run start-dev

Server listens on port 8080

Running the tests

To run test cases

npm test

Working Routes

API Endpoints

Endpoint	Functionality	HTTP method
/api/v1/auth/signup	Create a user account	POST
/api/v1/auth/login	Login a user	POST
/api/v1/loans	Create a loan application	POST
/api/v1/loans	Get all loan applications	GET
/api/v1/loans/loan_id	Get a specific loan application	GET
/api/v1/loan_id/repayments	View all loan repayment History	GET
/api/v1/user_email/verify	Mark User as Verified	PATCH
/api/v1/loans?status=approved&repaid=false	View all current loans(not fully repaid)	GET
/api/v1/loans?status=approved&repaid=true	View all current repaid loans	GET
/api/v1/loan/loan_id	Reject or approve loan	PATCH
/api/v1/loan_id/repayment	Create a repayment record	POST
/api/v1/users/password	Reset Pasword	POST
/api/v1/users/	Get All Users	GET
/api/v1/users/:email	Get A Single User	GET
/api/v1/docs	Read API documentation	GET

License 💥

This project is under the MIT LICENSE