README improvements

This commit is contained in:
Teemu Patja 2017-10-29 18:30:17 +02:00
parent 49617ae10e
commit a53cc04dd0
No known key found for this signature in database
GPG Key ID: F5B7035E6580FD4C
1 changed files with 39 additions and 7 deletions

View File

@ -44,29 +44,57 @@ Lauch a local geth node with the bot account unlocked:
```
#!/bin/bash
geth --fast --testnet --cache=1024 --datadir=$HOME/.ropsten --verbosity 4 --port 50100 --ipcpath ~/.ropsten/geth.ipc --rpc --rpcaddr 127.0.0.1 --rpcport 8545 --rpcapi db,eth,net,web3,personal --rpccorsdomain""https://wallet.ethereum.or"" --unlock""YOUR_ADDR"" --password <(echo""YOUR_PASSWD"")
geth --fast --testnet --cache=1024 --datadir=$HOME/.ropsten --verbosity 4 --port 50100 --ipcpath ~/.ropsten/geth.ipc --rpc --rpcaddr 127.0.0.1 --rpcport 8545 --rpcapi db,eth,net,web3,personal --rpccorsdomain "https://wallet.ethereum.org" --unlock "0xYOUR_ADDR" --password <(echo "YOUR_PASSPHRASE")
```
Launch following commands each in its own shell:
Launch the following command in a separate shell:
```
lein run
lein figwheel
lein less auto
```
_NOTE_
Next you want to start a REPL on the backend and the frontend.
Due to a current limitation you will have to do the following to have `lein run` work:
```
lein repl
```
Now you can start a CLJS repl with:
```
(use 'figwheel-sidecar.repl-api)
(start-figwheel!)
(cljs-repl)
```
(Alternatively, if you use emacs and CIDER, you can run cider-jack-in. Details [here](https://cider.readthedocs.io/en/latest/up_and_running/))
Next start the application from the clojure REPL with:
```
(user/start)
```
### Gotchas
Due to a current limitation you will get the following exception from the clojure compiler with dev builds:
```
Caused by: java.lang.ClassNotFoundException: commiteth.eth.contracts.TokenReg, compiling:(commiteth/eth/token_registry.clj:1:1)
```
The problem is the java classes generated by web3j have not been compiled. It can be worked around by running these commands:
```
lein build-contracts
lein jar
lein repl # this will fail
cp -r target/classes/commiteth target/base+system+user+dev/classes
lein run
```
This should be fixed to project.clj ASAP.
## Uberjar build
To create a standalone uberjar:
@ -80,6 +108,10 @@ This creates `target/uberjar/commiteth-<git-sha>.jar`
## Testing
### QA
Please refer to [doc/testing.md](https://github.com/status-im/commiteth/blob/develop/doc/testing.md)
### Clojure tests
```