Quick-credit-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 away to alleviate poverty and empower low income earners.
Folder structure
Within Quick-credit-api folder you WIll find the following directories and files. Cross check in any of the file misses the app may have a problem while bieng excetuted
Quick-credit-api-v1/
│
├── api/
│ ├── models/
│ ├── middleware/
│ └── routes
├── tests/
├── .gitignore/
├── index.mjs
├── package.json
└──README.md
Getting Started
By running the following command quick-credit-api will be automatically downloaded to your local machine so lets get started.
run
npm i quick-credit-api
or
git clone https://github.com/swaibat/quick-credit-ui.git
Prerequisites
before you install the software make sure you have the following already installed on your machine
- nodejs get it here
- Nodemon installed globally by runing
npm i nodemon -g
Installing api
A step by step series of examples that tell you how to get a development env running
- run
npm i
To install all the necessary packages on your local computer
- To start your sever
npm start
this will start your application and run on port 3000
- ### Endpoints and methods
So now you can access the following routes using provided methods
method | for what |
---|---|
POST | To POST NEW users and loans |
GET | TO GET all + specific users and loans |
PATCH | To EDIT some portion of data |
And repeat
Running the tests
TO run the test for the api
npm run test
or you can view the completed tests on server via coveralls
Break down into end to end tests
these tests specifically targets the following
- All the http methods to ease api usage and avoid errors in the code.
- all Errors to easily identify error message and course of error.
- Tests for Admin Access to specific routes to avoid other users Access to admin routes.
- check whetther the tokens are posted successfully
- All status codes to make sure all error and success are catered for ``
coding tests
all test are located in the test folder at the root called test
and Mocha,Chaiand Supertest have been used as testing framework
here is sample code
;
Author
- Rumbiiha Swaibu - Initial work - swaibat