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.

• Pivotal Tracker stories
• UI Templates

1. User sign up and sign in
2. User can apply for a loan
3. User can view all loan repayment history.
4. Admin can mark a client as verified after confirming the client’s work or home address.
5. Admin can view all loan applications.
6. Admin can view a specific loan application.
7. Admin can view current loans (not fully repaid).
8. Admin can view all repaid loans.
9. Admin can approve or reject a client’s loan application.
10. Admin can post loan repayment transaction in favour of a client.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Ensure you have the following installed on your local machine:

• NodeJS

• Express - web framework
• Nodejs- Runtime Environment for Javascript.
• Mocha, Chai, and supertest - Test framework and other dependencies
• nyc and istanbul - for coverage test.
• morgan - logging library

• POST /api/v1/auth/signup
• POST /api/v1/auth/signin
• POST /api/v1/users/:id/address
• POST /api/v1/users/:id/job
• POST /api/v1/loans
• GET /api/v1/loans
• PATCH /api/v1/users/:email/verify
• PATCH /api/v1/loans/:id
• GET /api/v1/loans/:id
• POST /api/v1/loans/:id/repayment
• GET /api/v1/loans/:id/repayment

Frontend Quick-Credit Heroku https://quick-credit-v1.herokuapp.com/

To run the application on your local machine, please follow the guidelines below.

• Install Nodejs on your machine
• Clone the repository
• cd into project folder
• Install the dependencies and devDependencies

Example

>git clone https://github.com/Pomile/Quick-Credit.git
>cd into quick-credit
>npm install

Enter the command below in the project root directory to the run the app in a development enviroment. In this case you will need to download and use Postman to perfom your test. Before you start the server in development make sure you do the following:

1. Follow installation guidelines
2. Install postgres
3. Create database for development
4. create .env file and define your variables

   TOKEN_SECRET = xxxxxxx
   PG_DATABASE=xxxxx
   PG_PASSWORD=xxxxx
   PG_PORT=xxxx
   PG_USERNAME=xxxxxx
   TEST_DATABASE=xxxx_credxxx_test
   DEV_DATABASE=xxxk_xxxx_dev
   TRAVIS_PASSWORD=null
   DB_PORT=xxxx
   DB_PASSWORD=xxxx
   DB_USER=xxxx
   DB_HOST=xxxxx
   ADMIN_PASSWORD=xxxxx

3. Run the command below.

>npm start:dev

Enter the command below in the project root directory to run the app in a test enviroment.

1. Follow installation guidelines
2. Install postgres
3. Create database for test
4. create .env file and define variables. See example in development.
5. Execute the command below

>npm run local:test
   or
>npm run test-with-nodemon

API BLUEPRINT docs

github url

https://pomile.github.io/Quick-Credit/dist/

To log in as an admin user use

Email: [email protected]
password: kingslanding1
click submit button

To develop the frontend with webpack devServer and have it open in a browser, please follow the guidelines below:

1. open command line
2. Clone the project https://github.com/Pomile/Quick-Credit.git
3. cd to the root of the project directory
4. enter `npm install`
5  Enter `npm run start:webpack-frontendServer`
6. Open another command line
7. Repeat step 3
8. Enter `npm run start:dev` - This is to start the server

• Clone the repository.
• Install dependencies
• Create a new branch for included feature(s)
• Raise a pull request.

Babatunde Ogedengbe