https://github.com/walletconnect/notify-client-js
https://github.com/walletconnect/notify-client-js
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/walletconnect/notify-client-js
- Owner: WalletConnect
- License: apache-2.0
- Created: 2022-11-24T16:38:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T14:25:31.000Z (about 2 years ago)
- Last Synced: 2025-06-13T19:25:19.174Z (12 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@walletconnect/notify-client
- Size: 785 KB
- Stars: 7
- Watchers: 4
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WalletConnect Notify Client
> Notify Client is currently under active development. This means updates could modify the API, remove deprecated features, or change default behavior.
>
> Please check the [release summaries](https://github.com/WalletConnect/notify-client-js/releases) for any notes on important changes between versions.
## Installation
```sh
npm install
```
## Commands
- `clean` - Removes build folders from all packages
- `lint` - Runs [eslint](https://eslint.org/) checks
- `prettier` - Runs [prettier](https://prettier.io/) checks
- `build` - Builds all packages
- `test` - Tests all packages
- `npm-publish` - Publishes packages to NPM. Requires an OTP code to be input on publish.
## Unit Tests
- The `vitest` test environment automatically pulls in the environment variables defined in `testEnv.json`
- These can be manually overridden by prefixing the desired custom vars: `TEST_PROJECT_ID=... yarn test`
## Publishing
1. Bump the version for the specific package and create the equivalent tag, e.g. for a patch:
```sh
cd packages/notify-client
npm version patch # will update package.json and package-lock.json
git commit -m "chore(release): 2.x.x"
git tag 2.x.x
```
2. Run the desired `npm-publish` script from the root directory:
```sh
npm run npm-publish # will auto-trigger each pkg's prepare/prepublishOnly scripts
```
#### Publishing Canaries
To publish canary versions under the `canary` dist tag, follow the same steps as above, but set the version using
the last commit's short hash (`git log --oneline | head -n1`), e.g. if the current version is `2.2.2`:
```sh
# ...
npm version 2.2.2-bb147cb
# ...
```
Then from the root directory, run:
```sh
npm run npm-publish:canary # will auto-trigger each pkg's prepare/prepublishOnly scripts
```
## License
Apache 2.0