Skip to content

Commit

Permalink
[doc] add a README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
anton-karlovskiy committed Feb 8, 2021
1 parent 82d87d3 commit 6494186
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"identicon",
"noopener",
"noreferrer",
"stakers",
"unstaking"
]
}
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 6494186

Please sign in to comment.