Thanks for looking here. Contributions are welcome! If you've got any questions when it comes to setup(or the project overall), feel free to open an issue/start a discussion
We're using pnpm instead of npm, so make sure you've got it installed(npm install -g pnpm
).
- Clone the repository
- run
pnpm install
in the root directory of the project - run
pnpm start <flags>
to run the project
script | description |
---|---|
pnpm lint |
Lint staged code |
pnpm test |
Test your code with jest |
pnpm build |
Build the app |
To release:
- Checkout a new branch
git checkout -b chore/release
- Run
pnpm release
and thenpnpm publish
. Push changes. - Merge the release branch