1
0
mirror of https://github.com/oceanprotocol/react-tutorial synced 2024-11-22 09:47:01 +01:00
react-tutorial/README.md

54 lines
2.1 KiB
Markdown

[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://oceanprotocol.com)
<h1 align="center">react-tutorial</h1>
> 🦄🦑 React + web3.js + squid.js interacting in the most minimal way with Ocean Protocol.
This app implements the full Ocean flow of registering, searching, and consuming assets. It is meant to be used alongside the React tutorial series in our docs:
- [**React Tutorial: React App Setup**](https://docs.oceanprotocol.com/tutorials/react-setup/)
- [**React Tutorial: Publish a Data Set**](https://docs.oceanprotocol.com/tutorials/react-publish-data-set/)
- [**React Tutorial: Get & Use a Data Set**](https://docs.oceanprotocol.com/tutorials/react-get-use-data-set/)
<a href="https://docs.oceanprotocol.com/tutorials/react-setup/"><img width="947" alt="Screen Shot 2019-08-09 at 12 10 50" src="https://user-images.githubusercontent.com/90316/62772018-cb4e0d80-ba9e-11e9-9492-1118943c6c7b.png"></a>
## 🦄 CodeSandbox
This repository is available on CodeSandbox as a playground.
[![Edit react-tutorial](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/oceanprotocol/react-tutorial/tree/master/?fontsize=14)
## 🦑 Get Started Locally
```bash
git clone git@github.com:oceanprotocol/react-tutorial.git
cd react-tutorial
npm install
npm start
```
Open [http://localhost:3000](http://localhost:3000) in your browser.
## 🎁 Contributing
See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concepts/contributing/)" in the Ocean Protocol documentation.
## 🏛 License
```text
Copyright 2019 Ocean Protocol Foundation Ltd.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```