DEVELOPMENT.md

Development

The @react-three/jolt repository is structured as a yarn monorepo.

You will find published packages inside ./packages, and deployed applications in ./apps.

Node

This project uses node 20.

If you don't already use a node version manager. Give nvm a try:

https://github.com/nvm-sh/nvm

Yarn

This project uses yarn 4.

If you have Corepack enabled, you should be able to use this project's yarn version without doing anything special. If you don't have Corepack enabled, you can enable it by running the following:

> corepack enable

Building

Once you have the above installed, run the following to install dependencies and build the project:

> yarn install
> yarn build

Examples

To run the examples, you can run the following:

> cd apps/examples
> yarn dev

Sidenote: to get HMR to work while running examples, open a seperate terminal to the react-three-jolt package and run:

yarn build -w

Versioning

This project uses @changesets/cli to manage versioning and releases.

As changes are made, changesets should be added with yarn change. This will open an interactive prompt to help you describe the changes you've made.

A github action will create a PR for bumping the version based on changesets.