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.

Build Status

Build status of continous integration i.e travis, coveralls and codeclimate

Motivation

This App is a challenge that will contritube greatly to my journey of becoming a world class developer.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Here is the environment prerequisite for the web app

- NodeJS
- PostgreSQL

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

• Clone the repository git clone https://github.com/IsaiahRn/Quick-Credit.git
• Copy config.sample to config then correct change the corresponding variables
• Run npm install to install node packages
• Run npm run server to start the web app

End with an example of getting some data out of the system or using it for a little demo

Running the tests

• Run npm test

Endpoints

Using Postman to access these endpoints Please find the API documentation on https://quick-creditapp.herokuapp.com/api-docs

Endpoint	Methods	Functionalities
/api/v1/auth/login	POST	Login registered user
/api/v1/auth/signup	POST	Register a new User
/api/v1/users/<:user-email>/verify	PATCH	Verify a user account
/api/v1/loans/<:loan-id>	GET	Get a specific loan application
/api/v1/loans?status=approved&repaid=false	GET	Get all current loans, not fully repaid
/api/v1/loans?status=approved&repaid=true	GET	Get all repaid loans
/api/v1/loans	GET	Get all loan applications
/api/v1/loans/<:loan-id>/repayments	GET	View loan repayment history
/api/v1/loans	POST	Create a loan application
/api/v1/loans/<:loan-id>	PATCH	Approve or reject a loan application
/api/v1/loans/<:loan-id>/repayment	POST	Create a loan repayment record

Built With

• HTML
• Javascript
• CSS
• NodeJS / Express
• PostgreSQL

Hosted API

Preview Hosted API(Heroku) here: Hosted api

UI templates

Preview UI template(Github Pages) here: UI Template

Authors

• Isaie Runoro Github Profile

Acknowledgments

• Esther Nammanda
• Shalon Ngigi
• Olawale Aladeusi
• Brad Traversy Media