https://quickcreditgilli.herokuapp.com/api/v1
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.
- Real Time email notification on approval or rejection of loan application.
- 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 interface is hosted here. API is hosted here. Swagger documentation here.
User Interface
- Hyper Text Mark-up Language
- Cascading Styles Sheet
- Javascript
- NodeJS - A runtime environment based off of Chrome's V8 Engine for writing Javascript code on the server.
- ExpressJS - A Web framework based on Node.js.
Development Tools
- Babel - A javascript transpiler.
- ESlint - A javascript code linting library.
- Airbnb - ESlint style guide.
Testing tools
| METHOD | DESCRIPTION | ENDPOINT |
|---|---|---|
| POST | Create user account | POST /auth/signup |
| POST | Login a user | POST /auth/signin |
| PATCH | Mark a user as verified. | PATCH /users/<:user-email>/verify |
| GET | Get all current loans that are not fully repaid. | GET /loans?status=approved&repaid=false |
| GET | Get a specific loan application. | GET /loans/<:loan-id> |
| GET | Get all repaid loans. | GET /loans?status=approved&repaid=true |
| GET | GET /loans | Get all loan applications. |
| GET | View loan repayment history. | GET /loans/<:loan-id>/repayments |
| POST | Create a loan application | POST /loans |
| PATCH | Approve or reject a loan application. Specify the status in the request’s body. | PATCH /loans/<:loan-id> |
| POST | Create a loan repayment record. | POST /loans/<:loan-id>/repayment |
Installation
- Install the latest version of nodeJS
- Clone this repository using git clone https://github.com/successgilli/quick-credit.git
- Run npm install to install all dependencies.
- Run npm start to start the server.
- Navigate to
localhost:8080/api/v1in your browser to access the application.
Testing
- Install Postman
- Test the endpoints manually by sending requests to
localhost:8080/endpoint - Run
npm teston your local terminal to test automatically.
AWAJI-MITOP N. GILBERT