Giter VIP home page Giter VIP logo

react-orbitdb's Introduction

react-orbitdb

react hooks and providers for dealing with IPFS orbit-db datasources.

You can see a demo here : https://revolunet.github.io/react-orbitdb

Provider

OrbitProvider creates a shared IPFS Node and an orbit-db instance.

import { OrbitProvider } from "react-orbitdb";

const App = () => <OrbitProvider>...</OrbitProvider>;

Hooks

useOrbitDb

useOrbitDb connects and return records from an OrbitDB database. records are updated in real-time.

import { useOrbitDb } from "react-orbitdb";

const MyCmp = () => {
  const { db, records } = useOrbitDb("/orbitdb/somehash/my-db, {
    create: true,
    type: 'eventlog'
  });

  return (
    <div>
      {records &&
        records.map((record) => <div key={record.id}>{record.message}</div>)}
    </div>
  );
};
  • options : OrbitDB.open options
    • the options.create and options.public values set the database world-writeable when you first create it.

useOrbit

useOrbit is included in OrbitProvider, you should not need it

useIpfs

useIpfs is included in OrbitProvider, you should not need it

react-orbitdb's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

react-orbitdb's Issues

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

How to use react-orbitdb with react 18.x

I created a brand new react app with react 18.x

yarn create react-app my-react-orbitdb 
cd my-react-orbitdb  
yarn add react-orbitdb
yarn start 

Then I replaced App.js with such code:

import {OrbitProvider,useOrbitDb} from 'react-orbitdb'

const App = () => (
  <div>
    <OrbitProvider>
      <h1>Test</h1>
    </OrbitProvider>
  </div>
);

export default App;

My browser console was showing me this error:
"Invalid hook call. Hooks can only be called inside of the body of a function component. This could happen for one of the following reasons: 1. You might have mismatching versions of React and the renderer (such as React DOM) 2. You might be breaking the Rules of Hooks 3. You might have more than one copy of React in the same app See https://reactjs.org/link/invalid-hook-call for tips about how to debug and fix this problem."

Then deleted node_modules and yarn.lock. did npm install instead of yarn install and yes react-orbitdb is based on react 16.x.

Now I am trying to replace my react 18 libs with react 16 ones but I am becoming a bit overwhelmed.
react-orbitdb usees parcel in the example project, but as far as I understand react-scripts 5.x is using webpack here?
I just wanted to leave this here if theres a solution for such kind of questions.

react-orbit npm package doesn't contain anything

I wanted to yarn add react-orbitdb into a brand new react project but when I looked into node_modules/react-orbitdb it is empty. Also the hooks etc. are missing. the dependencies (ipfs, orbitdb,etc.) seem to be installing. So far I didn't have time to look into the reason.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.