aboutsummaryrefslogtreecommitdiffstats
path: root/packages/kovan-faucets/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/kovan-faucets/README.md')
-rw-r--r--packages/kovan-faucets/README.md78
1 files changed, 0 insertions, 78 deletions
diff --git a/packages/kovan-faucets/README.md b/packages/kovan-faucets/README.md
deleted file mode 100644
index 07bd23575..000000000
--- a/packages/kovan-faucets/README.md
+++ /dev/null
@@ -1,78 +0,0 @@
-## @0xproject/kovan_faucets
-
-This faucet dispenses 0.1 test ether to one recipient per second and 0.1 test ZRX every 5 seconds. It has a max queue size of 1000.
-
-## Installation
-
-This is a private package and therefore is not published to npm. In order to build and run this package locally, see the [Install Dependencies](#Install-Dependencies) section and onwards below.
-
-## Contributing
-
-We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
-
-Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
-
-### Install Dependencies
-
-If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
-
-```bash
-yarn config set workspaces-experimental true
-```
-
-Then install dependencies
-
-```bash
-yarn install
-```
-
-### Start
-
-Set the following environment variables:
-
-```bash
-export FAUCET_ENVIRONMENT=development
-export DISPENSER_ADDRESS=0x5409ed021d9299bf6814279a6a1411a7e866a631
-export DISPENSER_PRIVATE_KEY=f2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257d
-export FAUCET_ROLLBAR_ACCESS_KEY={GET_THIS_FROM_ROLLBAR_ACCOUNT_SETTINGS}
-export INFURA_API_KEY={GET_THIS_FROM_INFURA}
-```
-
-Infura API Key can be requested here: https://infura.io/register.html
-
-Note: The above public/private keys exist when running `testrpc` with the following option `--mnemonic concert load couple harbor equip island argue ramp clarify fence smart topic`.
-
-```bash
-yarn dev
-```
-
-### Endpoints
-
-`GET /ether/:recipient`
-
-Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
-
-`GET /zrx/:recipient`
-
-Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
-
-### Docker configs
-
-```
-docker run -d \
--p 80:3000 \
---name kovan-faucets \
---log-opt max-size=100m \
---log-opt max-file=20 \
--e DISPENSER_ADDRESS=$DISPENSER_ADDRESS \
--e DISPENSER_PRIVATE_KEY=$DISPENSER_PRIVATE_KEY \
--e FAUCET_ROLLBAR_ACCESS_KEY=$FAUCET_ROLLBAR_ACCESS_KEY \
--e FAUCET_ENVIRONMENT=production \
-kovan-faucets
-```
-
-### Lint
-
-```bash
-yarn lint
-```