add img files;

add default frpc.ini file for config;
add to README;

Author: yan-man

.DS_Store

@@ -1,13 +1,109 @@
+# Appraisr
+
+Every time
+
+Appraisr is a decentralized ratings system similar to Yelp or Google Reviews.
+
+## System Requirements
+
+- [Metamask](https://metamask.io/) wallet with [Chrome](https://www.google.com/chrome/) / [Brave](https://brave.com/) browser
+
+- [Node](https://nodejs.org/en/download/) v16.14.0
+
+- Download MacOS-compatible [FRP](https://github.com/fatedier/frp/releases) - required to connect from [Moralis to local Ganache instance](https://docs.moralis.io/guides/deploy-and-track-erc20-events#connecting-moralis-to-your-local-ganache-instance).
+
+  Follow Moralis how-to [guide](https://docs.moralis.io/guides/deploy-and-track-erc20-events#connecting-moralis-to-your-local-ganache-instance). Use Hardhat setting with Linux command.
+
+  Sample [`frpc.ini`](./config/frpc.ini) file can be found at `./config/`
+
+![FRPC](./README/FRPC.png)
+
+\*This demo has been tested on MacOS Monterey v12.0.1, with React app deployed on local Brave browser (v1.37.113) via Node v16.14.0. FRP version [frp_0.42.0_darwin_amd64](https://github.com/fatedier/frp/releases).
+
+## Quick Start
+
+On Terminal 1 clone this repository and install its dependencies:
+
+```sh
+$ git clone https://github.com/yan-man/appraisr.git
+$ cd appraisr
+$ npm install
+```
+
+On the same terminal (Terminal 1), start Hardhat's network node:
+
+```sh
+$ npx hardhat node
+```
+
+On a new terminal (Terminal 2), connect Moralis to Ganache Proxy Server via FRP, according to Moralis guide:
+
+```sh
+$ ./frpc -c frpc.ini
+```
+
+Successful response:
+
+![FRPC start](./README/frpc-start.png)
+
+On a new terminal (Terminal 3), go to the repository's root folder and run the script to
+deploy the collection of smart contracts and configure initial settings.
+
+Initial Config Settings:
+
+See helper file [library.json](./frontend/src/helpers/library.json)
+
+- 2 initial sample Organizations will be created
+- 2 sample reviews given for each Organization by a total of 4 separate sample test accounts
+- 1 Verifier token given to each of the 20
+
+```sh
+$ npx hardhat run scripts/deploy.js --network localhost
+```
+
+Successful response:
+
+![deploy-scripts](./README/deploy-scripts.png)
+
 1. start npx node
 2. run deployment scripts
 3. start frpc
 4. add moralis details to index
 5. npm run start
 
-next steps/ further:
+## User Guide
+
+### Moralis
+
+## Smart Contracts
+
+## Mechanics
+
+### Chainlink VRF
+
+## Testing
+
+## Design Patterns
+
+## Troubleshooting
+
+## Further
 
 - split Appraiser contract into separate smaller contracts for bytesize
 - rewrite tests, add more integration testing
 - more front end functionality:
 - flesh out JSON metadata pin to IPFS for minted review NFTs
 - show Verifier tokens owned by user
+
+## What's Included?
+
+- [Frontend/Dapp](./frontend): A [Create React App](https://github.com/facebook/create-react-app) dApp which interacts with the `*.sol` smart contract.
+- [Hardhat](https://hardhat.org/): An Ethereum development task runner and testing network.
+- [Mocha](https://mochajs.org/): A JavaScript test runner.
+- [Chai](https://www.chaijs.com/): A JavaScript assertion library.
+- [ethers.js](https://docs.ethers.io/v5/): A JavaScript library for interacting with Ethereum.
+- [Waffle](https://github.com/EthWorks/Waffle/): To have Ethereum-specific Chai assertions/matchers.
+
+## License
+
+All non-boilerplate code is unlicensed. Yan Man 2022.

README.md

@@ -0,0 +1,8 @@
+[common]
+  server_addr = k9yyldx5xvzu.usemoralis.com
+  server_port = 7000
+  token = o6wnhm4DbU
+[hardhat]
+  type = http
+  local_port = 8545
+  custom_domains = k9yyldx5xvzu.usemoralis.com

README/FRPC.png

@@ -1,5 +1,5 @@
 {
-  "Appraiser": "0x99bbA657f2BbC93c02D617f8bA121cB8Fc104Acf",
-  "Reviewer": "0x4826533B4897376654Bb4d4AD88B7faFD0C98528",
-  "VRFv2Consumer": "0x8f86403A4DE0BB5791fa46B8e795C547942fE4Cf"
+  "Appraiser": "0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512",
+  "Reviewer": "0x5FbDB2315678afecb367f032d93F642f64180aa3",
+  "VRFv2Consumer": "0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9"
 }

README/deploy-scripts.png

@@ -13,7 +13,7 @@
         "Upvotes": 0,
         "Downvotes": 0,
         "reviewId": 1,
-        "Timestamp": 1653633732,
+        "Timestamp": 1653638896,
         "IsVerified": true
       },
       {
@@ -23,13 +23,13 @@
         "Upvotes": 0,
         "Downvotes": 0,
         "reviewId": 2,
-        "Timestamp": 1653633733,
+        "Timestamp": 1653638898,
         "IsVerified": true
       }
     ],
     "orgId": 0,
-    "AppraiserOrganization": "0x0AdECc0079Cab72DDe413b2634a811C15D2D3c21",
-    "Verifier": "0x3E69aeCb6a5abAc2D87d6707649E2fB0173ee2Da",
+    "AppraiserOrganization": "0x9f1ac54BEF0DD2f6f3462EA0fa94fC62300d3a8e",
+    "Verifier": "0xCafac3dD18aC6c6e92c921884f9E4176737C052c",
     "AvgRating": 54.5
   },
   {
@@ -47,7 +47,7 @@
         "Upvotes": 0,
         "Downvotes": 0,
         "reviewId": 1,
-        "Timestamp": 1653633734,
+        "Timestamp": 1653638895,
         "IsVerified": true
       },
       {
@@ -57,12 +57,12 @@
         "Upvotes": 0,
         "Downvotes": 0,
         "reviewId": 2,
-        "Timestamp": 1653633735,
+        "Timestamp": 1653638897,
         "IsVerified": true
       }
     ],
     "orgId": 1,
-    "AppraiserOrganization": "0x74bE95FF2Bb67B49ca168ec5f682a03f0c8f3269",
-    "Verifier": "0x0a52519F97941C942752eE44156A6EdeCA156Cdd"
+    "AppraiserOrganization": "0x93b6BDa6a0813D808d75aA42e900664Ceb868bcF",
+    "Verifier": "0xbf9fBFf01664500A33080Da5d437028b07DFcC55"
   }
 ]