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.
This project was developed with:
- Express.js - The server-side framework used
- JavaScript - The Scripting language used
- HTML - To structure UI templates
- CSS - To style UI templates
- PostgreSQL - Database to persist data
This project uses editorConfig to standardize text editor configuration.
This project uses eslint, together with the Airbnb style guide to look out for suspicious code.
- Text editor such as VS Code
- Install node.js
- Install PostgreSQL
- Clone the repo
git clone https://github.com/suleyunus/quick-credit.git
- Install all dependencies using npm
npm install
npm run start:dev
Once the server is running, open a REST client of choice (eg Postman) to test the API endpoints.
These test logic to APIs including authentication and validation.
npm run test
These check for suspicious code
npm run eslint
This app is yet to be deployed. Follow the project to get instructions on how to deploy on a live system.
This app has the following functionality:
- 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).
- dmin can view all repaid loans.
This app has the following API endpoints:
- POST /auth/signup
- POST /auth/signin
- PATCH /users/<:user-email>/verify
- GET /loans/<:loan-id>
- GET /loans?status=approved&repaid=false
- GET /loans?status=approved&repaid=true
- GET /loans
- GET /loans/<:loan-id>/repayments
- POST /loans
- PATCH /loans/<:loan-id>
- POST /loans/<:loan-id>/repayment
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch
- Commit your Changes
- Push to the Branch
- Open a Pull Request
While contributing to the project, kindly adhere to the Gitflow Workflow and naming conventions and best practices