orbit-utils

A collection of utility packages for Orbit.js.

See a utility package's README.md for more information about that particular utility package.

• @orbit-utils/zod-to-model-definition
• @orbit-utils/any-api-source

Development environment

You need to set up a development environment in order to:

• Develop / contribute to the library

Configuring the development environment the recommended way

The recommended way to set up the development environment is to use VSCode and the Dev Containers extension and clone the repository in a container volume. This way everything is set up for you automatically.

If you don't want to use VSCode and the Dev Containers extension, read on about configuring the development environment.

Configuring the development environment manually

1. Install Node.js v16.13 or newer (the newer, the better).

2. Enable Corepack so that the correct package manager is used. If you installed Node.js using Homebrew, you'll need to install Corepack separately:

   brew install corepack

   Else, Corepack is bundled with Node.js, and to enable it, all you need to do is run the command:

   corepack enable

3. Install project dependencies by running the following command in the root of your repo.

   pnpm install