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

Shared utility functions
https://github.com/pooltogether/pooltogether-utilities

Last synced: about 2 months ago
JSON representation

Shared utility functions

• Host: GitHub
• URL: https://github.com/pooltogether/pooltogether-utilities
• Owner: pooltogether
• License: mit
• Created: 2021-04-19T21:58:28.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-18T19:40:25.000Z (almost 2 years ago)
• Last Synced: 2024-11-08T23:06:47.652Z (about 2 months ago)
• Language: TypeScript
• Size: 10.7 MB
• Stars: 4
• Watchers: 5
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PoolTogether utilities

A collection of various utility functions 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 Utils from '@pooltogether/utilities'` OR `import { functionYouWantToUse } from '@pooltogether/utilities'`

## Local development

Local development works best with yalc

`yarn global add yalc`

In pooltogether-utilities:

`yarn start`

In the app you're importing pooltogether-utilities:

`yalc link @pooltogether/utilities`

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

## TODO:

- moooooore tests