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.
- User can reset password.
- Integrate real time email notification upon approval or rejection of a loan request.
Ensure you have the following installed on your local machine:
-
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
- 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
.
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 resourcePATCH
Update a resourceGET
Get a resource or list of resourcesDELETE
Delete a resource
For POST
and PATCH
requests, the body of your request may include a JSON payload.
Each response will be returned with one of the following HTTP status codes:
200
OK
The request was successful400
Bad Request
There was a problem with the request (security, malformed)401
Unauthorized
The supplied API credentials are invalid403
Forbidden
The credentials provided do not have permissions to access the requested resource404
Not Found
An attempt was made to access a resource that does not exist in the API500
Server Error
An error on the server occurred
- Design for Developers by Sarah Drasner
- Github Sign In/Sign Up page
- A quick guide to styling buttons using CSS by Ashwini Sheshagiri
- Button Hover Effects by Dave Conner
- CSS Flexbox by CSSTricks
- w3Schools
- Building a Simple API with NodeJS & Express by Olawale Aladeusi:raised_hands:
The QuickCredit API is open-sourced software licensed under the MIT license.