Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sahilpabale/sonic-sdk
Sonic SDK enables you to quickly setup and integrate your decentralized community in a flash!
https://github.com/sahilpabale/sonic-sdk
community decentralized orbis react-library reactjs sdk
Last synced: 16 days ago
JSON representation
Sonic SDK enables you to quickly setup and integrate your decentralized community in a flash!
- Host: GitHub
- URL: https://github.com/sahilpabale/sonic-sdk
- Owner: sahilpabale
- License: mit
- Created: 2022-12-11T06:48:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-12T05:49:59.000Z (about 1 year ago)
- Last Synced: 2024-12-06T06:17:30.682Z (about 1 month ago)
- Topics: community, decentralized, orbis, react-library, reactjs, sdk
- Language: TypeScript
- Homepage: https://0xsonic.vercel.app
- Size: 1.31 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@0xsonic/sdk
Sonic SDK enables you to quickly setup and integrate your decentralized community in a flash!
[](https://npmjs.com/@0xsonic/sdk)
[](https://npmjs.com/@0xsonic/sdk)
[](https://github.com/sahilpabale/sonic-sdk)
[](LICENSE)
Table of Contents:
- [Getting Started](#📦-getting-started)
- [Installation](#installation)
- [NPM](#npm)
- [Yarn](#yarn)
- [PNPM](#pnpm)
- [Usage](#usage)
- [Features](#-features)
- [Support](#-support)
- [Contributing](#-contributing)
- [Builders](#-builders)
- [License](#-license)
## 📦 Getting Started
### Installation
If not by the docs, we have a video to walk you through the installation and setting up sonic in your dapp.
[](https://www.loom.com/share/7153d2f0079d4a9184877b146b763d05)
#### NPM
```bash
npm install @0xsonic/sdk
```
#### Yarn
```bash
yarn add @0xsonic/sdk
```
#### PNPM
```bash
pnpm install @0xsonic/sdk
```
### Usage
React-js Application:
> **Warning**
> Currently 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.
Add `GENERATE_SOURCEMAP=true` in front of `react-scripts start` so the warning goes off!
```json
// package.json
"scripts": {
"start": "GENERATE_SOURCEMAP=false react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject",
},
```
```js
// src/index.js
import React from 'react';
import ReactDOM from 'react-dom/client';
import App from './App';
import { SonicProvider } from '@0xsonic/sdk';
// ...
root.render(
// wrap around your react app component
);
```
```js
// src/App.js
import React from 'react';
import { Sonic } from '@0xsonic/sdk';
function App() {
return (
<>
// enables decentralised comments for your dapp
>
);
}
export default App;
```
## 💻 Features
1. ``
SonicProvider wrapper helps us to manage the states and connection with Orbis & Ceramic protocol under the hood.
2. ``
Sonic is the main plug-&-play comments widget that dApps can use to integrate decentralised comments feature with 0 headache.
3. ``
WIP 🏗 A easy to use forums widget for all Web3ians
4. ``
WIP 🏗 Another quick, plug-&-play chat widget for dApps, dGames
## 🚀 Support
| Framework | Version |
| :----: | :----: |
| react-js | 0.2.6 ✅ |
| next-js | 0.3.0 🏗 |
| react-ts | 0.3.5 🏗 |
| next-ts | 0.4.0 🏗 |
| vue | 0.5.0 🏗 |
| svelte | 0.6.0 🏗 |
We plan to release these major versions and support all the leading web frameworks in coming months.
## ✅ Contributing
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.
## 👨🏻💻 Builders
[](https://twitter.com/SahilPabale)
[](https://twitter.com/AnishDe12020)
## 📄 License
This repository is available under the [MIT License](./LICENSE).