Giter VIP home page Giter VIP logo

quickcredit's Introduction

Quick Credit

Build Status Coverage Status Maintainability Test Coverage License: MIT GitHub issues

Project Overview

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.

Features

  1. User (client) can sign up.
  2. User (client) can login.
  3. User (client) can request for only one loan at a time.
  4. User (client) can view loan repayment history, to keep track of his/her liability or responsibilities.
  5. Admin can mark a client as verified, after confirming his/her home and work address.
  6. Admin can view a specific loan application.
  7. Admin can approve or reject a client’s loan application.
  8. Admin can post loan repayment transaction in favour of a client.
  9. Admin can view all loan applications.
  10. Admin can view all current loans (not fully repaid).
  11. Admin can view all repaid loans.

Optional Features

  1. User can reset password.
  2. Integrate real time email notification upon approval or rejection of a loan request.

Project Pipeline

Technologies Used

Getting Started

Prerequisites

Ensure you have the following installed on your local machine:

Installing/Run locally

  • Make sure you have nodejs, postgres installed.

  • Clone or fork repo 🤷‍♂️

      - git clone https://github.com/meetKazuki/QuickCredit.git
      - cd QuickCredit
      - npm install
  • Create/configure .env environment with your credentials

  • Run sh npm run dev-start to start the server and watch for changes

Testing

  • To test or consume the API locally, you can make use of Postman to simulate a front-end client.
  • You can also test by running npm test.

HTTP Requests

All API requests are made by sending a secure HTTPS request using one of the following methods, depending on the action being taken:

  • POST Create a resource
  • PATCH Update a resource
  • GET Get a resource or list of resources
  • DELETE Delete a resource

For POST and PATCH requests, the body of your request may include a JSON payload.

HTTP Response Codes

Each response will be returned with one of the following HTTP status codes:

  • 200 OK The request was successful
  • 400 Bad Request There was a problem with the request (security, malformed)
  • 401 Unauthorized The supplied API credentials are invalid
  • 403 Forbidden The credentials provided do not have permissions to access the requested resource
  • 404 Not Found An attempt was made to access a resource that does not exist in the API
  • 500 Server Error An error on the server occurred

Inspiration/Resources

License

The QuickCredit API is open-sourced software licensed under the MIT license.

quickcredit's People

Contributors

meetkazuki avatar

Watchers

James Cloos 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.