Giter VIP home page Giter VIP logo

quick-credit's Introduction

Quick-credit Build Status Coverage Status Maintainability

Getting started

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

REQUIREMENTS

  • User (client) can sign up
  • User (client) can login
  • User (client) can request for only one loan at a time
  • User (client) can view loan repayment history, to keep track of his/her liability or responsibilities
  • User (client) can update profile to meetup requirement after profile rejection
  • Admin can mark a client as verified , after confirming his/her home and work address
  • 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

Install dependencies

npm install
  • Starting the development server
 npm start
  • npm tests
 npm run tests

Dependancies

Nodejs Runtime environment that helps to run javascript both on the server and browser
Express NodeJS framework used for making the back-end.

Joi request body error validation and HTTP Request

Heroku

visit link: https://quick-creditv1.herokuapp.com/

API-Endpoints

JSON Object is returned for every API endpoint, structure of return JSON Object:

  - POST /api/v1/auth/signup Create user account

  - POST /api/v1/auth/signin Login a user

  - GET /api/v1/user Get all user

  - GET /api/v1/user/<:id> Get a user

  - PATCH /api/v1/user/<:id> Update a user

  - DELETE /api/v1/user/<:id> Delete a user

  - POST /api/v1/loans Create a loan application

  - GET /api/v1/loans/<:loan-id>/repayment View loan repayment history

  - GET /api/v1/loans Get all loan applications

  - GET /api/v1/loans?status=approved&repaid=false Get all current loans that are not fully repaid

  - GET /api/v1/loans?status=approved&repaid=true Get all repaid loans.

  - PATCH /api/v1/users/<:user-email>/verify Mark a user as verified

  - GET /api/v1/loans/<:loan-id> Get a specific loan application

  - PATCH /api/v1/loans/<:loan-id>/approve or reject a loan application

  - PATCH /api/v1/loans/<:loan-id>/reject or reject a loan application

  - POST /api/v1/loans/<:loan-id>/repayment Create a loan repayment record


quick-credit's People

Contributors

pngabo avatar

Watchers

 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.