open-bounty/README.md

86 lines
1.5 KiB
Markdown
Raw Normal View History

2017-03-09 14:34:40 +00:00
# Commiteth
2017-01-23 06:19:16 +00:00
Allows you to set bounties for Github issues, paid out in Ether.
More information:
http://wiki.status.im/proposals/commiteth/
Live alpha version:
2017-01-23 06:19:16 +00:00
https://commiteth.com
2017-08-19 09:11:53 +00:00
The `master` branch is automatically deployed here.
Live testnet (Ropsten) version:
2017-08-19 09:11:53 +00:00
https://commiteth.com:444
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
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-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
```
## 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
### 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
## 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)