Back to gallery
Vertx Studio Docs
DocsAPIChangelogShowcase
⌘K
GitHub

Getting started

  • Introduction
  • Installation
  • Project structure
  • Editor setup

Core concepts

  • Routing
  • Data fetching
  • Caching
  • Streaming

Building

  • Components
  • Styling
  • Forms & mutations
  • Authentication

Deploying

  • Vercel
  • Self-hosting
  • Environment variables
DocsGetting startedInstallation
v2.4 · Stable

Installation

Set up Vertx Studioin a brand-new project in under five minutes. We'll assume you have Node.js 20+ installed.

Prerequisites

Vertx Studioruns anywhere Node.js does, but we test against the latest LTS. You'll also want a package manager - we use pnpm in our examples but npm and yarn work just as well.

Tip. Already have a project? Skip ahead to the migration guide.

Create a new project

Run the create command and answer the prompts. The CLI will scaffold a TypeScript app preconfigured with Vertx Studio's defaults.

pnpm create my-app
cd my-app
pnpm dev

Add to an existing app

Install the runtime and the CLI as dev dependencies, then run example-cli init to generate config files.

pnpm add @example/runtime
pnpm add -D @example/cli
pnpm example-cli init

Next steps

You're ready to start building. Open app/page.tsx and start editing - Vertx Studio will hot-reload as you go.

  • Read the project structure guide.
  • Wire up your first data fetcher.
  • Deploy to Vercel in one click.
Edit this page

On this page

  • Prerequisites
  • Create a new project
  • Add to an existing app
  • Next steps