Turn any topic into clear, structured lessons.

Try for free

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Local Development
• Supporters

Getting Started

Prerequisites

• Node.js v24
• pnpm v11
• PostgreSQL v18

We recommend using mise to manage your Node.js and pnpm versions.

Installation

• pnpm install to install dependencies for all apps and packages
• Check out the @zoonk/db package README for database setup instructions
• Check out the main app README for app-specific setup instructions

Local Development

• pnpm dev to start the development server
• pnpm build to create a production build
• pnpm lint to run linting
• pnpm typecheck to run TypeScript type checking
• pnpm knip --production to check for unused code
• pnpm test to run tests with Vitest
• pnpm e2e to run end-to-end tests with Playwright
• pnpm i18n:lint to run i18n linting
• pnpm i18n to translate missing i18n keys

Supporters

See everyone who has supported this project.