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.
- 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.
- 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.
Quick Credit is built using the following technologies
- Nodejs
- Express
- Mocha and Chai
- Eslint
- Babel
- TravisCI
- CodeClimate
- Make sure you have a stable version of node installed
- Clone this repository https://github.com/Omokay/QuickCredit.git
- Go to the project directory
cd quickcredit
- Install all the dependencies from your CLI using
npm install
- Run the app using
npm start
server listens on port 4000 and use the postman collection to consume the API - To perform tests use
npm test
Action | Request Type | Endpoint |
---|---|---|
User signup | POST | /api/v1/auth/signup |
User signin | POST | /api/v1/auth/signin |
Mark user as verified | PATCH | /api/v1/users/:email-id |
Get specific loans | GET | /api/v1/loans/:loan-id |
Get all current loans not fully repaid | GET | /api/loans?status=approved&repaid=false |
Get all repaid loans | GET | /api/v1/loans?status=approved&repaid=true |
Get all loans | GET | /api/v1/loans |
Create a loan application | POST | /api/v1/loans |
View loan repayment history | GET | /api/v1/loans/:loan-id/repayments |
Approve or reject a loan application | PATCH | /api/v1/loans/:loan-id |
Post a loan repayment record | POST | /api/v1/loans/:loan-id/repayment |
- Project Homepage: https://omokay.github.io/QuickCredit/
- Repository: https://github.com/Omokay/QuickCredit
- Pivotal Tracker: https://www.pivotaltracker.com/n/projects/2326579
Swagger: https://app.swaggerhub.com/apis/Omokay/Quick_Credit/1.0.0
Quick credit is under the MIT License
Chuku Omoke David