Welcome to Microfinance dApp Documentation

Introduction

• Application Overview
  • Layered Architecture
  • Demo Video
• Functionalities
• Applications
• Smart Contracts
• Other Functionalities

Installation Guide

• Installation Guide
  • Install Git
  • Install Node
  • Install Truffle
  • Install Ganache
  • Install MetaMask
  • Install Mongo DB
• Checking Out the GitLab Project
  • Project Structure
  • Deployment Diagram
• Deploy Smart Contract to the Ganache
  • Run Ganache
  • Deploy Smart Contracts using Truffle
• Using Metamask with Ganache
  • Setting up Metamask
• Bank Web Server
  • Prerequisites
  • Install NPM Dependencies
  • Start Bank Server
  • Check Bank Server Availability
  • Swagger API Documentation
• Bank Web Application - ReactApp
  • Prerequisites
  • Install Bank Web Application Dependencies
  • Run Bank Web Application
• Connecting ReactApps to MetaMask

Smart Contracts

• Truffle Project Overview
  • Project Structure
• Smart Contracts
  • 1. Micro Token Smart Contract - MicroToken.sol
    • Attributes
    • Constructor
    • Functions
  • 2. User Identity Smart contract - UserIdentity.sol
    • enum
    • struct
    • Modifiers
    • Attributes
    • Constructor
    • Functions
  • 3. Bank Loan Smart Contract - BankLoan.sol
    • State Transition Diagram of The Bank Loan
    • enum
    • struct
    • Event
    • Modifiers
    • Attributes
    • Constructor
    • Functions
• Smart Contract Migration
  • Smart Contract Dependency Diagram
  • Initial Migration
  • Micro Token Smart Contract Migration
  • User Identity and Bank Loan Smart Contract Migration
• Truffle Configuration

Bank Web Server

• Server Overview
  • Project Structure
  • Project Dependencies
  • Prerequisites
• index.js
• Layered Architecture
  • API Layer
  • Service Layer
  • Data Layer

Bank Web Application

• App Overview
  • Project Structure
  • Project Dependencies
  • Prerequisites
• User Context
  • Import Dependencies
  • UserContext
  • UserContextProvider
  • Complete userContext Script
• Smart Contract Context
  • Import Dependencies
  • Web3 Provider
  • Smart Contract Address
  • Smart Contract Objects
  • Complete smartContractContext Script

Event Flows

• Event Overview
  • Page Navigation with Menu Items
  • Read Values from Smart Contract
  • Save Data to Smart Contract
  • Apply Loan Event Flow
  • Create Loan Plan Event Flow
  • Fetch Loan Plans from Bank Web Server
  • Edit Loan Plans Event Flow
  • Delete Loan Plan Event Flow
  • Loans Table Event Flows
• Page Navigation with Menu Items
  • Broker’s view:
  • Borrower’s view:
  • Bank user’s view:
• Read Values from Smart Contract
• Save Data to Smart Contract
• Apply Loan Event Flow
  • apply-loans.js
  • LoanForm.js
• Create Loan Plan Event Flow
  • plan.js
  • CreatePlanForm.js
  • postApi Method of fetchApi.js
• Fetch Loan Plans from Bank Web Server
  • plans.js
  • PlansTable.js
  • getApi Method of fetchApi.js
• Edit Loan Plans Event Flow
  • PlansTable.js
  • patchApi Method of fetchApi.js
• Delete Loan Plan Event Flow
  • PlansTable.js
  • deleteApi Method of fetchApi.js
• Loans Table Event Flows
  • loans.js
  • LoansTable.js
• Token Transfer Event Flow
  • TransferController.js
  • Transfer Form Component
  • Transaction Confirm Component
  • Transaction Success Component
  • Transaction Fail Component
• Loan Payment Update Event Flow
  • Loan Payment Form Component
  • Complete Loan Payment Form Component

Quickstart

• Quickstart Instructions
  • 1. Install Dependencies
  • 2. Checkout the Project from GitLab
  • 3. Deploy Smart Contract to Ganache
  • 4. Setup MetaMask
  • 5. Run Bank Web Server
  • 6. Install React App Dependencies
  • 7. Run Bank Web Application
  • 8. Connect Bank Web Application to MetaMask
  • Load Data