open-bounty/README.md

147 lines
3.1 KiB
Markdown
Raw Normal View History

2018-01-17 09:13:06 +00:00
# Status Open Bounty
2018-01-17 09:15:46 +00:00
Allows you to set bounties for Github issues, paid out in Ether or any ERC-20 token.
2017-01-23 06:19:16 +00:00
More information:
2018-01-17 09:13:06 +00:00
https://wiki.status.im/Status_Open_Bounty
2017-01-23 06:19:16 +00:00
2018-01-17 09:13:06 +00:00
Live production version:
2017-10-30 17:20:08 +00:00
https://openbounty.status.im
2017-08-19 09:11:53 +00:00
The `master` branch is automatically deployed here.
Live testnet (Ropsten) version:
2017-10-29 08:59:28 +00:00
https://openbounty.status.im:444
2017-08-19 09:11:53 +00:00
The `develop` branch is automatically deployed here.
## Prerequisites
2017-07-26 21:50:08 +00:00
You will need [Leiningen](https://github.com/technomancy/leiningen) 2.0 or above installed.
2017-07-26 21:50:08 +00:00
### PostgreSQL
2017-10-30 17:17:16 +00:00
<<<<<<< HEAD
2017-07-26 21:50:08 +00:00
Make sure you install [PostgreSQL](https://www.postgresql.org/) and properly set it up:
```
sudo -u postgres psql -c "CREATE USER commiteth WITH PASSWORD 'commiteth';"
sudo -u postgres createdb commiteth
```
## Running
2017-07-26 21:50:08 +00:00
Launch following commands each in its own shell:
```
lein run
lein figwheel
lein less auto
2017-08-19 09:11:53 +00:00
```
2017-10-30 17:17:16 +00:00
=======
2017-07-26 21:50:08 +00:00
Make sure you install [PostgreSQL](https://www.postgresql.org/) and properly set it up:
```
sudo -u postgres psql -c "CREATE USER commiteth WITH PASSWORD 'commiteth';"
sudo -u postgres createdb commiteth
```
### solc
Solidity compiler [0.4.15](https://github.com/ethereum/solidity/releases/tag/v0.4.15) is required and needs to be in $PATH.
### web3j
Web3j [2.3.0](https://github.com/web3j/web3j/releases/tag/v2.3.0) is required and the command line tools need to be in $PATH.
## Running
2017-10-26 18:51:43 +00:00
Make sure `env/dev/resources/config.edn` is correctly populated.
Lauch a local geth node with the bot account unlocked:
```
#!/bin/bash
2017-10-29 16:30:17 +00:00
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")
2017-10-26 18:51:43 +00:00
```
2017-10-29 16:30:17 +00:00
Launch the following command in a separate shell:
2017-07-26 21:50:08 +00:00
```
lein less auto
2017-08-19 09:11:53 +00:00
```
2017-10-29 16:30:17 +00:00
Next you want to start a REPL on the backend and the frontend.
2017-10-26 18:51:43 +00:00
2017-10-29 16:30:17 +00:00
```
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)
```
2017-08-19 09:11:53 +00:00
## Uberjar build
2017-07-26 21:50:08 +00:00
2017-08-19 09:11:53 +00:00
To create a standalone uberjar:
```
lein uberjar
2017-07-26 21:50:08 +00:00
```
2017-08-19 09:11:53 +00:00
This creates `target/uberjar/commiteth-<git-sha>.jar`
## Testing
2017-10-29 16:30:17 +00:00
### QA
Please refer to [doc/testing.md](https://github.com/status-im/commiteth/blob/develop/doc/testing.md)
### Clojure tests
2017-07-26 21:50:08 +00:00
```
lein test
```
### ClojureScript tests
2017-07-26 21:50:08 +00:00
```
lein with-profile test doo phantom test
```
### Reagent component devcards
2017-07-26 21:50:08 +00:00
```
lein with-profile test figwheel devcards
```
Open http://localhost:3449/cards.html
### Update landing page
2017-10-30 16:10:27 +00:00
Landing page is static and different CSS and JS due to time constraints.
- Build CSS with Gulp (see `static_landing_page/README.md`
- Make changes and `./build-landing-page.sh`
This copies over necessary artifacts to `resources` dir.
## License
2017-03-09 14:34:40 +00:00
Licensed under the [Affero General Public License v3.0](https://github.com/status-im/commiteth/blob/master/LICENSE.md)