From d846c7a6fa0f7b82a6d8a6b6d9559e6f7f97b08f Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Thu, 15 Nov 2018 11:34:21 +0100 Subject: [PATCH] Copyedited README.md, fixed minor errors, added more examples --- README.md | 71 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 46 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 8e26832..c0a3ac8 100644 --- a/README.md +++ b/README.md @@ -53,35 +53,63 @@ To get the `latest` versions of all components, referring to their `develop` bra After getting everything running, you can open the **Pleuston Frontend** application in your browser: -``` -http://localhost:3000 -``` +[http://localhost:3000](http://localhost:3000) ### Script Options -The script provides the following options: +The `start_ocean.sh` script provides the following options: -Option | Description ---- | --- +Option | Description +--- | --- `--latest` | Get the `latest` versions of all components, referring to their `develop` branches. `--no-pleuston` | Start up Ocean without an instance of `pleuston`. Helpful for development on `pleuston`. `--local-parity-node` | Runs a local parity POA node and Secret Store instead of ganache-cli. `--reuse-database` | Start up Ocean and reuse the Database from ganache. Helpful for development. -For example, the following command would run the latest version of the stack, without Pleuston and with the Parity + Secret Store nodes: +For example, if you do: -`./start_ocean.sh --latest --no-pleuston --local-parity-node` +```bash +./start_ocean.sh --latest +``` -## Ocean Protocol components +then the main/default [docker-compose.yml](docker-compose.yml) will be used, so the following Docker images will all be started: -The Ocean Docker compose starts the following components: +- mongo:3.6 +- oceanprotocol/keeper-contracts:latest +- oceanprotocol/aquarius:latest +- oceanprotocol/brizo:latest +- oceanprotocol/pleuston:latest -* [🦄 pleuston](https://github.com/oceanprotocol/pleuston). Frontend listening on port `3000`. -* [🐋 aquarius](https://github.com/oceanprotocol/aquarius). Backend listening on port `5000`. -* [💧 keeper-contracts](https://github.com/oceanprotocol/keeper-contracts). RPC client listening on port `8545`. -* [💧 secret-store](https://github.com/oceanprotocol/parity-ethereum). HTTP client listening on port `12001`. +To see what ports each of those listens on, read [docker-compose.yml](docker-compose.yml). Note that `keeper-contracts` runs a local Ganache node (not a local Parity Ethereum POA node). -![Ocean Protocol Components](doc/img/ocean-components@2x.png) +If you do: + +```bash +./start_ocean.sh --no-pleuston +``` + +then [docker-compose-no-pleuston.yml](docker-compose-no-pleuston.yml) will be used, so these images will be started: + +- mongo:3.6 +- oceanprotocol/keeper-contracts:stable +- oceanprotocol/aquarius:stable +- oceanprotocol/brizo:stable + +If you do: + +```bash +./start_ocean.sh --latest --local-parity-node +``` + +then [docker-compose-local-parity-node.yml](docker-compose-local-parity-node.yml) will be used. Read it to see what images it starts. Note that it _doesn't_ start Pleuston, and it _does_ start a Parity Secret Store. + +If you do: + +```bash +./start_ocean.sh --latest --no-pleuston --local-parity-node +``` + +then the last-selected Docker Compose file will be used, i.e. the one selected by `--local-parity-node`: [docker-compose-local-parity-node.yml](docker-compose-local-parity-node.yml). ### Parity Client Accounts @@ -102,20 +130,13 @@ export REUSE_DATABASE="true" docker-compose --project-name=ocean -f docker-compose-no-pleuston.yml up ``` -Variable | Description ---- | --- +Variable | Description +--- | --- `REUSE_DATABASE` | The keeper-contracts component runs with ganache by default and every run will produce and deploy new instances of the keeper contracts. Ganache can be run with a specific database path by setting the env var `REUSE_DATABASE` to `"true"`. By default, the ganache database will be setup in the cwd. `DEPLOY_CONTRACTS` | skip deploying smart contracts by setting this to `"false"`, in this case `REUSE_DATABASE` should be set to `"true"` in the previous run when using ganache `KEEPER_NETWORK_NAME` | set to one of `"ganache"` (default), `"kovan"`, or `"ocean_poa_net_local"` `ARTIFACTS_FOLDER` | this is where the deployed smart contracts abi files will be available. This can be pointed at any path you like. -A subset of the components can be run by modifying the docker-compose file directly or by using one of the other pre-built compose files: - -Compose file | Description ---- | --- -`docker-compose-no-pleuston.yml` | runs all components without the pleuston. This is useful for developing/debugging the front-end app. So first the docker compose container can be started then pleuston can be started separately from source. You can also use `./start_ocean.sh --no-pleuston` to do this -`docker-compose-local-parity-node.yml` | similar to the above with no pleuston, but runs a local parity POA node instead of ganache-cli. You can also use `./start_ocean.sh --local-parity-node` instead - ## Contributing We use GitHub as a means for maintaining and tracking issues and source code development. @@ -126,7 +147,7 @@ Ocean Protocol uses [C4 Standard process](https://github.com/unprotocols/rfc/blo ## License -``` +```text Copyright 2018 Ocean Protocol Foundation Licensed under the Apache License, Version 2.0 (the "License");