From fec194bc3fa6f600993ffd094e9ff3cb4cd12f37 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Wed, 27 Mar 2019 15:46:26 +0100 Subject: [PATCH] add prerequisites --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 387191f..9a7a1d4 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ [![js oceanprotocol](https://img.shields.io/badge/js-oceanprotocol-7b1173.svg)](https://github.com/oceanprotocol/eslint-config-oceanprotocol) [![css bigchaindb](https://img.shields.io/badge/css-bigchaindb-39BA91.svg)](https://github.com/bigchaindb/stylelint-config-bigchaindb) +- [Prerequisites](#prerequisites) - [Get Started](#get-started) - [Production](#production) - [Testing](#testing) @@ -17,6 +18,21 @@ screen shot 2019-02-08 at 16 53 57 +## Prerequisites + +To make use of all the functionality, you need to connect to the Ocean network. + +For local development, you can spin up [`barge`](https://github.com/oceanprotocol/barge) to use a local network: + +```bash +git clone git@github.com:oceanprotocol/barge.git +cd barge + +./start_ocean.sh --latest --no-pleuston --local-spree-node +``` + +The default configuration of the client & server is to connect to this local network. Modify `./client/src/config.ts`, and `./server/src/config/config.ts` to change that. + ## Get Started To spin up both, the client and the server in a watch mode for local development, execute: @@ -26,7 +42,7 @@ npm install npm start ``` -This will run client and server in development mode.
+This will run both, client and server in development mode.
Open [http://localhost:3000](http://localhost:3000) to view the client in the browser. The page will reload if you make edits to files in either `./client` or `./server`.