status-im/open-bounty
2
0
Fork 0
mirror of https://github.com/status-im/open-bounty.git synced 2025-01-12 18:44:38 +00:00
Code Issues Projects Releases Wiki Activity

Add TOC to README, remove duplicate 'Running' section

Browse Source
This commit is contained in:
Vitaliy Vlasov 2018-02-15 12:51:13 +02:00 committed by Martin Klepsch
parent 714b869a72
commit 162e53fdbc
1 changed files with 25 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -13,6 +13,15 @@ Live testnet (Ropsten) version:
https://openbounty.status.im:444 https://openbounty.status.im:444
The `develop` branch is automatically deployed here. The `develop` branch is automatically deployed here.
## Table of contents
- [Prerequisites](#prerequisites)
- [Application config](#application-config)
- [GitHub integration](#github-integration)
- [Running](#running)
- [Testing](#testing)
- [More info](#more-info)
## Prerequisites ## Prerequisites
@ -47,16 +56,6 @@ brew install https://raw.githubusercontent.com/web3j/homebrew-web3j/881cf369b551
brew pin web3j brew pin web3j
``` ```
## Running
Launch following commands each in its own shell:
```
lein run
lein figwheel
lein less auto
```
## Application config ## Application config
Make sure to create `/config-dev.edn` and populate it correctly, which is based on `env/dev/resources/config.edn`. Description of config fields is given below: Make sure to create `/config-dev.edn` and populate it correctly, which is based on `env/dev/resources/config.edn`. Description of config fields is given below:
@ -92,20 +91,32 @@ Follow the steps [here](https://developer.github.com/apps/building-github-apps/c
## Running ## Running
Lauch a local geth node with the bot account unlocked: ### Geth
Launch a local geth node with the bot account unlocked:
``` ```
#!/bin/bash #!/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.org" --unlock "0xYOUR_ADDR" --password <(echo "YOUR_PASSPHRASE") 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")
``` ```
### CSS auto-compilation
Launch the following command in a separate shell: Launch the following command in a separate shell:
``` ```
lein less auto lein less auto
``` ```
Next you want to start a REPL on the backend and the frontend. ### Clojure app without REPL
Launch following commands each in its own shell:
```
lein run
lein figwheel
```
### Clojure app with REPL
You'll have to start a REPL on the backend and the frontend.
``` ```
lein repl lein repl
@ -174,8 +185,8 @@ Landing page is static and different CSS and JS due to time constraints.
This copies over necessary artifacts to `resources` dir. This copies over necessary artifacts to `resources` dir.
### Troubleshooting ## More info
See the [Cookbook](doc/cookbook.md). Detailed information on code structure, troubleshooting, etc. can be found [here](doc/README.md).
## License ## License