1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-02 16:25:37 +01:00
docs/content/tutorials/react-setup.md

185 lines
8.2 KiB
Markdown
Raw Normal View History

2018-12-05 12:08:47 +01:00
---
title: React App Setup
description: This tutorial shows how you can build a basic [React](https://reactjs.org/) app with [Create React App](https://github.com/facebook/create-react-app) that uses the Ocean [JavaScript driver](https://github.com/oceanprotocol/ocean.js) to publish a data set, get a data set, and more.
WARNING: as of Oct 21, 2020 this has not been updated yet for Ocean V3.
2018-12-05 12:08:47 +01:00
---
2019-08-09 15:46:37 +02:00
## Git repository and CodeSandbox
All code snippets in this tutorial are sourced from the [oceanprotocol/react-tutorial](https://github.com/oceanprotocol/react-tutorial) GitHub repository:
<repo name="react-tutorial"></repo>
The final source of this tutorial is also available as a CodeSandbox:
[![Edit react-tutorial](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/oceanprotocol/react-tutorial/tree/master/?fontsize=14)
## Requirements
2018-12-06 14:43:27 +01:00
- `Node.js` >= 10 is installed. You can check using `node -v`
- `npm` >= 5.2 is installed. You can check using `npm -v`
- A Web3 capable browser, like Firefox/Chrome with [MetaMask](https://metamask.io) installed, [connected to Nile network](https://docs.oceanprotocol.com/tutorials/connect-to-networks/#connect-to-the-nile-testnet)
2019-08-09 14:02:52 +02:00
- Some Nile ETH from the Nile Faucet. You can either go to [commons.nile.dev-ocean.com/faucet](https://commons.nile.dev-ocean.com/faucet), or execute this command replacing `<YOUR ADDRESS>` with your MetaMask account address:
```bash
curl --data '{"address": "<YOUR ADDRESS>", "agent": "curl"}' -H "Content-Type: application/json" -X POST https://faucet.nile.dev-ocean.com/faucet
```
2019-04-04 11:56:56 +02:00
2019-08-09 13:30:13 +02:00
## New Create React App
2019-08-09 13:30:13 +02:00
We are going to use Create React App to bootstrap our React app. You could use `npx create-react-app marketplace` but it creates more files than needed for the scope of this tutorial.
2019-08-09 13:30:13 +02:00
So let's go minimal and build up our app from scratch with this structure:
2019-08-09 13:30:13 +02:00
```text
marketplace/
├── package.json
├── public/
├──── index.html
├── src/
├──── index.js
```
2019-08-09 13:30:13 +02:00
First, create a new project folder for your new app, e.g. `marketplace`. Within that, add a new file `package.json` with the following content:
2019-04-17 16:48:37 +02:00
2019-12-09 12:59:52 +01:00
GITHUB-EMBED https://github.com/oceanprotocol/react-tutorial/blob/master/package.json json GITHUB-EMBED
Notice the `@oceanprotocol/ocean.js` dependency, which is the [Ocean Protocol JavaScript library](https://github.com/oceanprotocol/ocean.js). Save that file, and in your terminal install the dependencies we have just defined in `package.json`:
```bash
2019-08-09 13:30:13 +02:00
npm install
```
2019-08-09 13:30:13 +02:00
Then create the HTML file used to render the React app into. For that, create a folder `public/` and in it a file `index.html` with the following content:
2019-12-09 12:59:52 +01:00
GITHUB-EMBED https://github.com/oceanprotocol/react-tutorial/blob/master/public/index.html html GITHUB-EMBED
2019-08-09 13:30:13 +02:00
## Add Basic Markup
Create a new folder `src/` and within that a `index.js` file with the following content as our base, where we already import ocean.js and web3.js:
2019-11-20 19:32:42 +01:00
GITHUB-EMBED https://github.com/oceanprotocol/react-tutorial/blob/e639e9ed4432e8b72ca453d50ed7bdaa36f1efb4/src/index.js jsx 1-4,6,14,100-110,122-127 GITHUB-EMBED
2019-08-09 13:30:13 +02:00
At this point you can start up the app and see the result in your browser:
2019-08-09 13:30:13 +02:00
```bash
npm start
```
2019-08-09 13:30:13 +02:00
Go to [localhost:3000](http://localhost:3000) to inspect your newly created app:
![Initial React App](images/react-app-01.png)
2019-08-09 16:32:25 +02:00
## Setup Web3
2019-08-09 13:30:13 +02:00
We already are importing web3.js but we still need to enable account access for the browsers supporting it, and make sure nothing breaks in browsers which are not Web3-capable.
2019-08-09 13:30:13 +02:00
To do that we add a simple check at top of `src/index.js` and then enable account access with:
2019-11-20 19:32:42 +01:00
GITHUB-EMBED https://github.com/oceanprotocol/react-tutorial/blob/e639e9ed4432e8b72ca453d50ed7bdaa36f1efb4/src/index.js jsx 7-12 GITHUB-EMBED
2019-07-16 16:17:34 +02:00
2019-08-09 13:30:13 +02:00
And let's also output some warning for non-Web3 browsers within our `render()` function:
2019-07-16 16:17:34 +02:00
2019-11-20 19:32:42 +01:00
GITHUB-EMBED https://github.com/oceanprotocol/react-tutorial/blob/e639e9ed4432e8b72ca453d50ed7bdaa36f1efb4/src/index.js jsx 112 GITHUB-EMBED
2019-08-09 13:30:13 +02:00
This should give you the following markup:
2019-11-20 19:32:42 +01:00
GITHUB-EMBED https://github.com/oceanprotocol/react-tutorial/blob/e639e9ed4432e8b72ca453d50ed7bdaa36f1efb4/src/index.js jsx 1-4,6-14,100-112,122-127 GITHUB-EMBED
After those steps go to your browser. You should see MetaMask asking you to allow access to your account:
![MetaMask confirmation](images/react-app-02.png)
2019-08-09 13:30:13 +02:00
> Note: If you see an error like `inpage.js:1 MetaMask - RPC Error: Internal JSON-RPC error.` in your browser console, don't worry about it. It's a MetaMask thing and won't affect functionality.
2019-04-02 13:18:59 +02:00
## Create Ocean Instance
Now that we are successfully connected with Web3, we can set up our Ocean instance.
2019-08-09 13:30:13 +02:00
At the beginning of your component, create a new Ocean instance with all required endpoint configurations within the `componentDidMount` lifecycle method. All Ocean Protocol operations can be executed from this Ocean instance.
2019-11-20 19:32:42 +01:00
GITHUB-EMBED https://github.com/oceanprotocol/react-tutorial/blob/e639e9ed4432e8b72ca453d50ed7bdaa36f1efb4/src/index.js jsx 15-16,19-28,35-39 GITHUB-EMBED
2019-08-09 13:30:13 +02:00
2019-08-09 15:10:32 +02:00
This will initiate a connection to all Ocean components in Nile, load the contracts, and finally store the Ocean object in the local component state for reuse.
We also set the `verbose` option of ocean.js so we better see what's going on.
2018-12-06 14:43:27 +01:00
## Final Result
That's it, if you have no errors in your `console.log` then you have successfully initialized an Ocean instance in your brand new React app and you are ready for the [next part of this tutorial](/tutorials/react-publish-data-set/).
![Initial React App with Ocean initiated](images/react-app-03.png)
2019-08-09 13:30:13 +02:00
Here is the full source of `src/index.js` that you should have if you followed this tutorial:
2019-08-09 15:57:39 +02:00
GITHUB-EMBED https://github.com/oceanprotocol/react-tutorial/blob/2765a7e6ae9a948d311d3949636cf832d2664900/src/index.js jsx 1-4,6-16,18-27,34-38,96-109,119-124 GITHUB-EMBED
2019-08-09 15:34:24 +02:00
**Move on to [Publish a Data Set](/tutorials/react-publish-data-set/).**
2019-08-09 13:30:13 +02:00
## Bonus: Connect against local network
2019-08-09 13:30:13 +02:00
Instead of remotely connecting to Rinkeby, you can connect to your own [local network](concepts/network-local). It uses Ethereum Ganache plus Ocean Barge.
2019-08-09 13:30:13 +02:00
2019-08-09 14:02:52 +02:00
```bash
git clone https://github.com/oceanprotocol/barge.git
cd barge/
2019-08-09 13:30:13 +02:00
./start_ocean.sh --no-commons
2019-08-09 14:02:52 +02:00
```
2019-08-09 13:30:13 +02:00
Compiling and deploying the contracts in your local network may take a few minutes.
2019-08-09 13:30:13 +02:00
2019-08-09 16:32:25 +02:00
### Copy Contract Artifacts
At the end of the contract compiling and deploying you need to copy the resulting contract artifacts from the Docker container to your local `@oceanprotocol/keeper-contracts` dependency folder. The _keeper-contracts_ Docker container will output all artifacts in a hidden folder in your home folder so you can copy from there:
2019-08-09 13:30:13 +02:00
2019-08-09 14:02:52 +02:00
```bash
cp ~/.ocean/keeper-contracts/artifacts/* ./node_modules/@oceanprotocol/keeper-contracts/artifacts/
```
### Get ETH for the local network
You will also need some ETH for your local network. [This tutorial](/tutorials/get-ETH-and-OCEAN-tokens) describes how to get it into your MetaMask account.
2019-08-09 16:32:25 +02:00
You can execute this, replacing `<YOUR ADDRESS>` with your MetaMask account address:
2019-08-09 14:02:52 +02:00
```bash
curl --data '{"address": "<YOUR ADDRESS>", "agent": "curl"}' -H "Content-Type: application/json" -X POST http://localhost:3001/faucet
```
2019-08-09 15:10:32 +02:00
2019-08-09 16:32:25 +02:00
### Adjust App Config
Finally, move back to your marketplace React app and modify the Ocean instance config in `src/index.js` to use the local network's endpoints:
2019-08-09 15:10:32 +02:00
2019-08-09 15:57:39 +02:00
```jsx
2019-08-09 15:10:32 +02:00
const ocean = await new Ocean.getInstance({
web3Provider: web3,
nodeUri: 'http://localhost:8545',
aquariusUri: 'http://aquarius:5000',
brizoUri: 'http://localhost:8030',
brizoAddress: '0x00bd138abd70e2f00903268f3db08f2d25677c9e',
secretStoreUri: 'http://localhost:12001',
verbose: true
})
```
2019-08-09 16:32:25 +02:00
> If you are on macOS, you need to additionally tweak your `/etc/hosts` file so Brizo can connect to Aquarius within Docker. This is only required on macOS and is a [known limitation of Docker for Mac](https://docs.docker.com/docker-for-mac/networking/#known-limitations-use-cases-and-workarounds):
>
> ```bash
> sudo vi /etc/hosts
>
> # add this line, and save
> 127.0.0.1 aquarius
> ```
>
> And then use `aquariusUri: 'http://aquarius:5000'` in your Ocean instance config.
2019-08-09 15:10:32 +02:00
Then start up the app as usual:
```bash
npm start
```
2019-08-09 15:57:39 +02:00
**Move on to [Publish a Data Set](/tutorials/react-publish-data-set/).**