@etherspot/react-etherspot
v1.2.0
Published
React Etherspot SDK provider
Downloads
1,091
Readme
Etherspot for React
- Website: https://etherspot.io
- Documentation: https://docs.etherspot.dev
- SDK Docs: https://sdk.etherspot.dev
- SDK Playground https://try.etherspot.dev
React Etherspot allows plug-and-play integration with the Etherspot SDK, allowing React dApps and developers to easily leverage the SDK in a highly customisable fashion.
Prerequisites
Please ensure that you have the Editor Config plugin installed for VS Code:
Name: EditorConfig for VS Code
Id: EditorConfig.EditorConfig
Description: EditorConfig Support for Visual Studio Code
Version: 0.16.4
Publisher: EditorConfig
VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig
Getting Started
Install React Etherspot using npm or yarn
npm i @etherspot/etherspot-react
Plug in your dApp
import {
Etherspot,
} from "@etherspot/react-etherspot";
/**
* This is all that is needed to get started.
* To customise this, see the possible props
* you can pass in the docs.
*/
function RenderEtherspot(props) {
return <Etherspot />;
}
Developing locally
You can set up React Etherspot locally and develop new features for it. Please follow the instructions below:
- First start with React project
- Then, checkout this repository
- In this repository directory: run
npm install && npm link
- In this repository directory:: run
npm run rollup:watch
- this project is now being watched for code changes - In the React project directory: run
npm install && npm link @etherspot/react-etherspot
- Run your React project
You can now make code changes in this repository and changes will be reflected in the Example dapp.
Contributions
Follow guide
Security
To report security issues please follow guide