[core] improve the project in several aspects

.gitignore

@@ -22,3 +22,4 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+/src/built-contracts

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+  "cSpell.words": [
+    "Unstake",
+    "bignumber",
+    "borderless",
+    "browserslist",
+    "defi",
+    "identicon",
+    "noopener",
+    "noreferrer",
+    "stakers",
+    "unstaking"
+  ]
+}

README.md

@@ -0,0 +1,30 @@
+
+# DeFi Demo
+
+DApp developed using the following tech stacks:
+
+- React.js (CRA)
+- Smart Contracts (Solidity)
+- Truffle
+- Ganache
+- Web3.js
+- Automated Tests using Mocha and Chai
+
+
+## Quick setup and running
+
+- Install node in the local (Node version is v12.18.3 and if possible, use the same version for compatibility).
+- Download Ganache from https://www.trufflesuite.com/ganache and install it in the local.
+- Run Ganache in the local.
+
+``` bash
+$ npm install --g [email protected] # If possible, use the same version for compatibility
+
+$ npm install # Or yarn install
+$ npm run truffle-compile # Compile smart contracts
+$ npm run truffle-migrate # (Or npm run truffle-migrate-reset) Deploy the compiled smart contracts
+$ npm run truffle-test # Run the automated tests to make sure of the behaviors of the smart contracts
+$ npm start # Run the UI website
+
+$ npm run truffle-issue-dapp-tokens # Issue Dapp tokens to the stakers
+```

migrations/1_initial_migration.js

@@ -1,4 +1,5 @@
-const Migrations = artifacts.require("Migrations");
+
+const Migrations = artifacts.require('Migrations');
 
 module.exports = function(deployer) {
   deployer.deploy(Migrations);

migrations/2_deploy_contracts.js

@@ -1,23 +1,24 @@
-const DappToken = artifacts.require('DappToken')
-const DaiToken = artifacts.require('DaiToken')
-const TokenFarm = artifacts.require('TokenFarm')
+
+const DappToken = artifacts.require('DappToken');
+const DaiToken = artifacts.require('DaiToken');
+const TokenFarm = artifacts.require('TokenFarm');
 
 module.exports = async function(deployer, network, accounts) {
   // Deploy Mock DAI Token
-  await deployer.deploy(DaiToken)
-  const daiToken = await DaiToken.deployed()
+  await deployer.deploy(DaiToken);
+  const daiToken = await DaiToken.deployed();
 
   // Deploy Dapp Token
-  await deployer.deploy(DappToken)
-  const dappToken = await DappToken.deployed()
+  await deployer.deploy(DappToken);
+  const dappToken = await DappToken.deployed();
 
   // Deploy TokenFarm
-  await deployer.deploy(TokenFarm, dappToken.address, daiToken.address)
-  const tokenFarm = await TokenFarm.deployed()
+  await deployer.deploy(TokenFarm, dappToken.address, daiToken.address);
+  const tokenFarm = await TokenFarm.deployed();
 
   // Transfer all tokens to TokenFarm (1 million)
-  await dappToken.transfer(tokenFarm.address, '1000000000000000000000000')
+  await dappToken.transfer(tokenFarm.address, '1000000000000000000000000');
 
-  // Transfer 100 Mock DAI tokens to investor
-  await daiToken.transfer(accounts[1], '100000000000000000000')
-}
+  // Transfer 100 Mock DAI tokens to investor (assume that accounts[0] => owner, accounts => investor)
+  await daiToken.transfer(accounts[1], '100000000000000000000');
+};

package.json

@@ -3,6 +3,10 @@
   "version": "0.1.0",
   "description": "DeFi Token Staking App",
   "author": "[email protected]",
+  "contributors": [
+    "[email protected]",
+    "Anton K. <[email protected]>"
+  ],
   "dependencies": {
     "babel-polyfill": "6.26.0",
     "babel-preset-env": "1.7.0",
@@ -26,7 +30,13 @@
     "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test",
-    "eject": "react-scripts eject"
+    "eject": "react-scripts eject",
+    "truffle-compile": "truffle compile",
+    "truffle-migrate": "truffle migrate",
+    "truffle-migrate-reset": "truffle migrate --reset",
+    "truffle-console": "truffle console",
+    "truffle-test": "truffle test",
+    "truffle-issue-dapp-tokens": "truffle exec scripts/issue-dapp-tokens.js"
   },
   "eslintConfig": {
     "extends": "react-app"

scripts/issue-dapp-tokens.js

@@ -0,0 +1,10 @@
+
+const TokenFarm = artifacts.require('TokenFarm');
+
+module.exports = async function(callback) {
+  const tokenFarm = await TokenFarm.deployed();
+  await tokenFarm.issueDappTokens();
+  // Code goes here...
+  console.log('Tokens issued!');
+  callback();
+};