Repository files navigation

Table of Contents:

• Getting Started
  • Installation
    • NPM
    • Yarn
    • PNPM
  • Usage
• Features
• Support
• Contributing
• Builders
• License

If not by the docs, we have a video to walk you through the installation and setting up sonic in your dapp.

npm install @0xsonic/sdk

yarn add @0xsonic/sdk

pnpm install @0xsonic/sdk

React-js Application:

WarningCurrently we're facing a source map issue which will throw some weird warnings in your react-app, for this we have a temporary solution to be added in package.json file.

AddGENERATE_SOURCEMAP=true in front ofreact-scripts start so the warning goes off!

// package.json"scripts": {"start":"GENERATE_SOURCEMAP=false react-scripts start","build":"react-scripts build","test":"react-scripts test","eject":"react-scripts eject",  },

// src/index.jsimportReactfrom'react';importReactDOMfrom'react-dom/client';importAppfrom'./App';import{SonicProvider}from'@0xsonic/sdk';// ...root.render(<React.StrictMode><SonicProvider> // wrap around your react app component<App/></SonicProvider></React.StrictMode>);

// src/App.jsimportReactfrom'react';import{Sonic}from'@0xsonic/sdk';functionApp(){return(<><Blog/><Soniccontext="blog-related-context"/> // enables decentralised comments for your dapp</>);}exportdefaultApp;

1. <SonicProvider />
   SonicProvider wrapper helps us to manage the states and connection with Orbis & Ceramic protocol under the hood.
2. <Sonic context=""/>
   Sonic is the main plug-&-play comments widget that dApps can use to integrate decentralised comments feature with 0 headache.
3. <SonicForum />
   WIP 🏗 A easy to use forums widget for all Web3ians
4. <SonicChat />
   WIP 🏗 Another quick, plug-&-play chat widget for dApps, dGames

We plan to release these major versions and support all the leading web frameworks in coming months.

All code contributions, including those of people having commit access, must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

We truly ❤️ pull requests! If you wish to help, we will soon be making our sdk ready to be contribute post hackathon, and we'll do a proper announcement for everyone to contribute.

This repository is available under theMIT License.