Quickstart Instructions

1. Install Dependencies

As described in the installation guide target install following dependencies in your computer.

Install git - To check out the project from the GitLab
Install Node - Node will use to install other dependencies like Truffle and Node is the package manager for the React App. This project requires the Node version 14.x.
Install Ganache - We use Ganache to run a local blockchain network on your computer.
Install MetaMask - MetaMask is used for wallet account management.
Install MongoDB - Bank web server uses the MongoDB to stores the data.

2. Checkout the Project from GitLab

As described in the checkout project target section, open a terminal in your computer and execute the following commands to checkout microfinance to your computer and change git branch to level1 branch.

git clone https://gitlab.com/gmc123/microfinance.git
cd microfinance/
git branch level1

3. Deploy Smart Contract to Ganache

First install all node dependencies for blockchain peoject using following command.

npm install

As described in the deploy smart contract target section first run Ganache on your computer.

Change directory to microfinance/blockchain/ directory on your terminal and execute following command to deploy smart contracts into the Ganache local blockchain network.

truffle migrate --reset

4. Setup MetaMask

As described in the metamask with ganache target section connect MetaMask to the Ganache local blockchain.

5. Run Bank Web Server

In your terminal change the directory to the bank-server directory and execute the following commands to install bank-server dependencies and run the bank-server.

npm install
npm run start

To check the Bank Server running correctly navigate to localhost:9091 in the browser. If the browser displays the Welcome to Bank Server then you can start the Bank Web Application.

6. Install React App Dependencies

In your terminal change the directory to the bank-web-app directory. Then execute the following command to install bank-web-app dependencies.

npm install

7. Run Bank Web Application

After successfully installing React App dependencies you can execute the following command inside the bank-web-app directory to run the React App.

npm run dev

Now navigate to localhost:3005 to in the browser to view the Bank Web Application.

8. Connect Bank Web Application to MetaMask

In your Google Chrome browser navigate to localhost:3005 and you will be able to see the Bank web app running on your browser. When you load the Bank web App on your browser MetaMask will ask to connect to Bank wen app (localhost:3005). You can connect wallet accounts as mentioned in the connect metamask reactapp target section.

Load Data

You can open a new terminal on example-data directory and first run the following command.

npm install

This will install all the node modules for the example-data project. Then run the following command to register users in the UserIdentity smart contract.

npm start

This will create the users as follows.

User Role	User Id	Name	Wallet Address	Social Security No.
Broker	1	Leonard Hofstadter	Ganache Account 2 address	2345
Borrower	1	Rajesh Koothrapali	Ganache Account 3 address	3455

Ganache Account 1 address is used by Bank.