Giter Club home page Giter Club logo

storex-hub-boilerplate's Introduction

Storex Hub boilerplate

This is a minimal boilerplate for both Storex Hub external applications, and plugins. It does basic things like:

  • Setting up a connection
  • Making sure you stay identified even on reconnect
  • Storing the access token in a JSON file (if running as an external app)
  • Setting up a StorageModule and making it usable with Storex Hub

Getting started

The basics:

  • git clone [email protected]:WorldBrain/storex-hub-boilerplate.git
  • cd storex-hub-boilerplate && rm -rf .git
  • yarn
  • Change APP_NAME in ts/constants.ts to something like org.your-org.your-plugin (reverse domain scheme)
  • Change identifierin manifest.json to to same as APP_NAME

To run as an external app, when for example making a CLI tool (also useble if you're making a front-end):

  • yarn start

To pack as a plugin and test it, when for example making an integration to an external platform (IPFS, Twitter, etc.):

  • yarn build:dev or yarn build:prod
  • cd <storex-hub-dir>
  • yarn cli plugin:install <this-repo>/build

Documentation

In the Storex documentation you can find out more about:

  • How to write a plugin
  • How to store data in Storex Hub
  • How to connect other external apps, like Memex
  • How to expose custom functionality through remote calls

storex-hub-boilerplate's People

Contributors

shishkabab avatar esttorhe avatar

Stargazers

Jonny Dubowsky avatar Gyuri Lajos avatar

Watchers

 avatar James Cloos avatar Oliver Sauter avatar  avatar

Forkers

esttorhe

storex-hub-boilerplate's Issues

Boilerplate app does not authenticate to Storex Hub

I tried to play around with the boilerplate code a bit, but noticed that it does not authenticate with the Storex Hub.
There's a registerOrIdentify method in application.ts, but this is never used.

I tried adding this call to the initialization-code in main.ts, but then ran into a chicken-and-egg problem:

  • registerOrIdentify requires an initialized client.
  • Registering the callbacks needed for client initialization requires authentication. It gives me the following error:

    Could not subscribe to Memex storage changes (yet?): not-identified

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.