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

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

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pooltogether/pooltogether-hooks
• Owner: pooltogether
• Created: 2021-05-19T19:37:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-23T23:27:22.000Z (almost 2 years ago)
• Last Synced: 2024-05-15T11:38:38.951Z (8 months ago)
• Language: TypeScript
• Size: 1.57 MB
• Stars: 8
• Watchers: 4
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PoolTogether hooks

A collection of various useful hooks used across the PoolTogether applications.

## NOTE

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

## How to use

1. `yarn add @pooltogether/utilities`

2. `import * as Hooks from '@pooltogether/hooks'` OR `import { hookYouWantToUse } from '@pooltogether/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/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/hooks`.

## TODO:

- jest tests