Getting Started

Prerequisites

First, enable corepack on your computer and install pnpm

npm install corepack@latest
# or
npm install --global corepack@latest # install it globally (for your user account) so you don't have to reinstall for every repository

Install pnpm

# run in Admin shell or use `sudo [command]`
corepack enable
corepack enable pnpm

Register pnpm for the project

Register pnpm as the package manager for the project in package.json:

corepack use pnpm@latest # if this fails, pnpm is already registered. install and update pnpm with the following
corepack install pnpm
pnpm self-update

Development Server

Next, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev # use pnpm. We have pnpm set as pkg manager in `package.json`

Open http://localhost:3000 with your browser to see the result.

You can start editing the API by modifying config/routes.oas.json. The dev server will automatically reload the API with your changes.