Skip to content

chidimo/Quick-Credit

Repository files navigation

Quick-Credit

Build Status Coverage Status Maintainability Test Coverage

Website

Quick Credit

Description

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. Create a user account
  2. Apply for a loan

Demo

https://qcredit.herokuapp.com/api/v1/

Installation

  1. Install yarn in your system. Check out the yarn installation docs
  2. Clone the repo using the GitHub link https://github.com/chidimo/Quick-Credit.git
  3. Open a cmd shell and cd into the root of the project.
  4. Install project dependencies with yarn install.
  5. Optionally install the development dependencies with yarn install --dev
  6. After installation of all dependencies, start the server with yarn start or yarn devstart.

Testing

  1. Clone the repo using the GitHub link https://github.com/chidimo/Quick-Credit.git
  2. Open a cmd shell and cd into the root of the project.
  3. Run command yarn test
  4. Alternative you can start the server with yarn devstart and use postman to make API calls to the endpoints defined above. You man use this postman collection

API Documentation

API documentation is available at https://qcredit.docs.apiary.io/

License

MIT

Author

Chidi Orji (orjichidi95@gmail.com)

Credits

  1. SVG icon from FontAwesome