https://github.com/worldbrain/storex-hub-boilerplate
Boilerplate for Storex Hub plugins and external apps
https://github.com/worldbrain/storex-hub-boilerplate
Last synced: 11 months ago
JSON representation
Boilerplate for Storex Hub plugins and external apps
- Host: GitHub
- URL: https://github.com/worldbrain/storex-hub-boilerplate
- Owner: WorldBrain
- Created: 2020-05-21T15:59:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T18:24:49.000Z (over 3 years ago)
- Last Synced: 2024-10-30T04:29:56.732Z (over 1 year ago)
- Language: TypeScript
- Size: 1.13 MB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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 git@github.com: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 `identifier`in `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 `
- `yarn cli plugin:install /build`
## Documentation
In the [Storex documentation](https://worldbrain.github.io/storex-docs/#/storex-hub/) 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