mirror of
https://github.com/oceanprotocol/commons.git
synced 2023-03-15 18:03:00 +01:00
Merge pull request #39 from oceanprotocol/feature/dev-instructions
dev instructions
This commit is contained in:
commit
769d377bde
18
README.md
18
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 @@
|
||||
|
||||
<img alt="screen shot 2019-02-08 at 16 53 57" src="https://user-images.githubusercontent.com/90316/52489283-27080e80-2bc2-11e9-8ec0-508c21eb86f7.png">
|
||||
|
||||
## 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.<br>
|
||||
This will run both, client and server in development mode.<br>
|
||||
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`.
|
||||
|
Loading…
Reference in New Issue
Block a user