Skip to content

Latest commit

 

History

History
76 lines (60 loc) · 2.12 KB

README.md

File metadata and controls

76 lines (60 loc) · 2.12 KB
Raw

got

This library is built on react hooks and react-redux. It manages several aspects of the graphbased database solution got, including authentication, the graph database actions, as well as the attached file hosting system.

Documentation

Getting Started

Installation

yarn add @gothub-team/got-react

npm install @gothub-team/got-react

Redux Store

To setup a react-redux store we simply need to create a store from our gotReducer.

import { createStore } from 'redux';
import { gotReducer } from '@gothub-team/got-react';

const rootReducer = combineReducers({
    got: gotReducer,
});
export const reduxStore = createStore(rootReducer);

We then need to wrap our app in redux's Provider component.

import { Provider } from 'react-redux';

export const App = () => (
    <Provider store={reduxStore}>
        <Content />
    </Provider>
);

Setup

To setup our got environment, we simply need to configure the setup function with a host for our API to connect to, the redux store and the name of got's state in said store.

import { setup } from '@gothub-team/got-react';

const host = 'https://api.gothub.io'; // or endpoint of different got provider
export const {
    api,
    store,
    useGraph,
} = setup({
    host,
    reduxStore,
    baseState: 'got',
});

This will give us the three main got components.

  • The api which implements all interactions with the got provider like push, pull, auth or upload actions.
  • The store which implements all interactions with the database.
  • useGraph which configures hooks to efficiently use got with react as well as most store functions with a given stack.

Alternatively all of these can be configured seperately using

  • createApi from '@gothub-team/got-api'
  • createStore from '@gothub-team/got-store'
  • createHooks from '@gothub-team/got-react'