chucheka/Quick-Credit-1

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. 

 

Quick-Credit

Quick Credit is an online lending platform that provides short term soft loans to individuals.

Pivotal Tracker Stories

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

UI hosted on gh pages

https://odunayookebunmi.github.io/Quick-Credit/UI/index.html

Server side hosted on Heroku

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

API Documentation

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

Table of Content

• Getting Started

• Prerequisites for installation

• Installation

• Test

• API End Points Test Using Postman

• Linting Style

• Features

• Built With

• Author

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/OdunayoOkebunmi/Quick-Credit

2. Install dependencies

e.g npm install.

3. Start the application by running the dev-start script.

e.g npm run dev-start

4. Install postman to test all endpoints on port 3000.

Test

run test using 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	Apply for loan
POST	/api/v1/loans/:id/repayment	Post Loan Repayment Transaction
PATCH	/api/v1/users/:email/verify	Verify User Status
PATCH	/api/v1/loans/:id	Approve or Reject Loans
GET	/api/v1/loans/:id/repayments	Get loan repayment records
GET	/api/v1/loans	Get all loan appplications
GET	/api/v1/loans?status=approved&repaid=false	Get all approved but not repaid loans
GET	/api/v1/loans?status=approved&repaid=true	Get all approved and repaid loans
GET	/api/v1/loans/:id	Specific Loans

Linting Style

• ESLint with Airbnb style guide.

Features

Admin

• Admin can mark a client as verified after confirming the client’s work or home  address. 
• 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 a client. 

Users

• A user can signup
• A user can signin to his/her account
• A user can apply for loan
• A user can view all loan repayment history

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.

• Vannila Javascript: It is used for scripting the client side.

Author

• Odunayo Olajumoke Okebunmi

License

This project is licensed under the MIT license - see the LICENSE.md file for details.