wpdas/near-social-bridge

This library allows you to create a common application using ReactJS and use it inside a BOS Component. Therefore, the BOS Component talks to the React application and vice versa, making it possible to consume Discovery API resources within the React application. Link to real-time tests below:

NEAR Social Bridge

This library allows you to create a common application using ReactJS and use it inside a BOS Component. Therefore, the BOS Component talks to the React application and vice versa, making it possible to consume the Blockchain Operating System resources within the React application.

Please consider making a donation if you liked this project.

Live Apps & Tutorials

Check out some apps using Near Social Bridge:

• NEAR Query API
• Chat App

Tutorials:

• Greeting App
• Todo App
• SSR NextJS Test App
• Decentralized App - Tutorial

Install

Install it using npm or yarn:

# npm
npm install near-social-bridge

# yarn
yarn add near-social-bridge

How to Use

Here's a complete guide where you can go over all features provided by Near Social Bridge.

Main Features

• Setup
• BOS API
  • Near API
  • Social API
  • Storage API
  • Fetch API
• Requests
  • Simple Request
  • Handling requests inside the BOS Component
  • Using request Utils inside the BOS Component
  • Requests - Concurrency
• Components
• Hooks
  • useNearSocialBridge
  • useConnectionStatus
  • useInitialPayload
  • useAuth
  • useWidgetView
  • useSyncContentHeight
• Preparing a new BOS Component
• Testing the Application with Local Viewer

Extra Features

• Database
• Mock
  • Setup Mocks
  • Mock Authenticated User
  • Mock Initial Payload
  • Create Requests Mocks
• Navigation
  • Implementing routes
• Session Storage
• Persist Storage
• BOSComponent - experimental
• Hooks
  • useBOSComponent - experimental
  • useNavigation
  • useSessionStorage
• Utils
  • initRefreshService
  • overrideLocalStorage

React / Next App Deployment

You can deploy your app in two ways: decentralized or centralized.

• Deploying to IPFS (CSR) - Decentralized
• Deploying to Vercel (SSR)

Contributing

Please read CONTRIBUTING.md.