https://github.com/pooltogether/bnc-onboard-hooks

https://github.com/pooltogether/bnc-onboard-hooks

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pooltogether/bnc-onboard-hooks
• Owner: pooltogether
• Created: 2021-09-27T18:47:37.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-13T18:44:42.000Z (over 2 years ago)
• Last Synced: 2024-04-23T21:42:34.611Z (9 months ago)
• Language: TypeScript
• Size: 680 KB
• Stars: 2
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PoolTogether bnc-onboard-hooks

Hooks for adding Onboard.js to PoolTogether dapps.

## NOTE

Make sure you keep `peerDependencies` and `devDependencies` versions in sync!

## How to use

1. `yarn add @pooltogether/utilities`

2. `import { hookYouWantToUse } from '@pooltogether/bnc-onboard-hooks'`

3. Ensure you call any required init functions early

## Local development

Local development works best with yalc

`yarn global add yalc`

In pooltogether-hooks:

`yarn start`

In the app you're importing pooltogether-hooks:

`yalc link @pooltogether/bnc-onboard-hooks`

When you save changes inside the hooks `src` folder, the package will rebuild and be pushed to all other projects that have run `yalc link @pooltogether/bnc-onboard-hooks`.

## TODO:

- jest tests