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.

Built with

• HTML and CSS
• Node.js
• Express
• Mocha for TDD
• TravisCI for Continous Integration and Development (CI/CD) The above are the core tech/framework used. This project sought to keep external dependencies to the bare minimum by at times reinventing the wheel for learning/development purposes.

    ├── server 
    │   ├── dist                  #transpiled server files
    │   ├── docs                  #documents include api doc
    │   ├── src                   #source files
    │   │   ├── controllers       #route controller files
    │   │   ├── helpers           #server helper files
    │   │   ├── lib               #library files
    │   │   ├── middleware        #express middleware files
    │   │   ├── model             #server moel files
    │   │   ├── routes            #express route files
    │   │   └── services          #express services (handles core business logic)
    │   └── test
    │       ├── api
    │       ├── helpers
    │       ├── middleware
    │       ├── model
    │       └── services
    └── UI                        #user interface files
        ├── assets
        │   ├── css
        │   ├── images
        │   └── js
        └── templates             #JS view template files

Airbnb javascript style was used in entirety of this project

These instructions seek to get your copy of the project up and running on your local machine for development and testing purposes. For deployment check the deployment section.

What things you need to install the software and how to install them

Ensure you have Node.js and npm installed

Clone this project git clone https://github.com/Merkll/Quick-Credit.git Run npm install to install all dependencies Run npm start For development Server run npm run start:dev

This project uses Mocha for test driven development. Ensure all test pass by running npm test

The API was documented using Swagger and the docs can be found in this route /api/v1/docs

To use this demo,

• signup at the auth endpoint /auth/signup

--OR--

• signin using this credentials email '[email protected]' passworddemouser at /auth/signup

• copy the token and set the Authorization header of your API client to the token

The demo server is https://quick-credit-staging.herokuapp.com

UI demo can be found here https://merkll.github.io/Quick-Credit

• Keystone.js for inspiration to build the dynamically loaded model files

A short snippet describing the license (MIT, Apache etc)

ISC © toluwase