Welcome to Microfinance dApp documentation

Note

This is level2 documentation for the Microfinance project. If you are looking for level1 documentation, select the correct branch at the bottom of the left panel.

Introduction:

• Application Overview
  • Layered Architecture
  • Demo Video

Installation Guide:

• Checking Out the GitLab Project
• Project Structure
  • Deployment Diagram
• Insurance Company Web Server
  • Prerequisites
  • Start Insurance Company Server
  • Check Insurance Company Server Availability
  • Swagger API Documentation
• Insurance Company Web Application - ReactApp
  • Prerequisites
  • Install Insurance Co. Web Application Dependencies
  • Run Insurance Co. Web Application

Smart Contracts:

• Truffle Project Overview
  • Project Structure
• Smart Contracts
  • User Identity Smart Contract - UserIdentity.sol
    • State Transition Diagram of The User
    • ENUM
    • Structs
    • Modifiers
    • Attributes
    • Constructor
    • Functions
    • Events
  • Bank Loan Smart Contract - BankLoan.sol
    • State Transition Diagram of The Bank Loan
    • ENUM
    • Structs
    • Events
    • Modifiers
    • Attributes
    • Constructor
    • Functions
  • Insurance Policy Smart Contract
    • State Transition Diagram of The Insurance Policy
    • ENUM
    • Structs
    • Events
    • Modifiers
    • Attributes
    • Constructor
    • Functions
• Smart Contract Migration
  • Smart Contract Dependency Diagram
  • Migration
    • User Identity and Other Smart Contract Migration

Insurance Co. Web Server

• Overview of Insurance Co. Web Server
  • Project Structure
  • Project Dependencies
  • Prerequisites
• Index.js
• Layered Architecture
  • API Layer
  • Service Layer
  • Data Layer

Insurance Co. Web Application:

• Overview of Insurance Co. Web Application
  • Project Structure
  • Project Dependencies
  • Prerequisites
• User Context
  • Import Dependencies
  • UserContext
  • UserContextProvider
  • Complete userContext Script
• Smart Contract Context
  • Import Dependencies
  • Web3 Provider
  • Smart Contract Addresses
  • Smart Contract Objects
  • Complete smartContractContext Script
• _app.js

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
  • 9. Run Insurance Company Web Server
  • 10. Run Insurance Web Application
  • Load Data