Getting started
App Quickstart
The recommended way to get started with Zudoku is to use the create-zudoku-app
CLI tool. This tool will scaffold a new Zudoku site for you to customize and build upon.
Prerequisites
- Node.js version 22 or higher
Getting Started
- Create a new Zudoku app by running:
npm create zudoku-app@latestbash
- Open the project in your code editor and replace the example OpenAPI file at
/apis/openapi.yaml
with your own OpenAPI schema.
You can use openapi.json
instead of YAML. Just update the file path in zudoku.config.ts
.
- Start the development server:
npm run devbash
Your Zudoku site is now running locally! Next, commit your changes and deploy the site to your preferred hosting provider.