Skip to content

Commit 1039a37

Browse files
committed
README updated - mainnet fork and solidity prettier script
1 parent 576c192 commit 1039a37

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,44 @@
66
npm install
77
```
88

9-
### Compile contracts
9+
### Compiles contracts
1010

1111
```
1212
npm run compile
1313
```
1414

15-
### Migrate contracts
15+
### Migrates contracts
1616

1717
```
1818
npm run migrate
1919
npm run migrate --network mycustomnetwork
2020
npm run migrate:reset
2121
```
2222

23-
### Run truffle tests
23+
### Runs truffle tests
2424

2525
```
2626
npm run test
2727
```
2828

29-
### Run truffle console
29+
### Runs truffle console
3030

3131
```
3232
npm run console
3333
```
3434

35-
### Run Solidity linter (solhint)
35+
### Runs Solidity linter (solhint)
3636

3737
```
3838
npm run solhint
3939
```
4040

41+
### Runs prettier on Solidity contracts
42+
43+
```
44+
npm run prettier:solidity
45+
```
46+
4147
### Compiles and hot-reloads for development
4248

4349
```
@@ -58,19 +64,31 @@ npm run lint
5864

5965
## Docker
6066

61-
### Run ganache-cli in docker - simplest version
67+
### Runs ganache-cli in docker - simplest version
6268

6369
```
6470
docker run --detach --publish 8545:8545 trufflesuite/ganache-cli:latest
6571
```
6672

67-
### Run ganache-cli in docker with additional parameters
73+
### Runs ganache-cli in docker with forked mainnet
74+
75+
```
76+
ganache-cli -f https://cloudflare-eth.com
77+
```
78+
79+
### Runs ganache-cli in docker with forked mainnet and unlocked account
80+
81+
```
82+
ganache-cli -f https://cloudflare-eth.com -u "0x41653c7d61609D856f29355E404F310Ec4142Cfb"
83+
```
84+
85+
### Runs ganache-cli in docker with additional parameters
6886

6987
```
7088
docker run --detach --publish 8545:8545 trufflesuite/ganache-cli:latest --verbose --blockTime=5 --accounts=20
7189
```
7290

73-
### Build production ready docker image
91+
### Builds production-ready Docker image (Nginx as a web server)
7492

7593
```
7694
docker build --tag dapp-vue-starter .

0 commit comments

Comments
 (0)