Skip to content
Velocits

Documentation

Getting started

From an empty directory to a running site.

Install

Add the framework and the tooling. Tailwind is optional but recommended; it is resolved from your application, not from the framework.
pnpm add @velocits/pages @velocits/renderer @velocits/server
pnpm add -D velocits tailwindcss @tailwindcss/node @tailwindcss/oxide

A page

Create app/page.tsx. The file name becomes the URL, and a default export becomes the page. The export may be async.
import { getProducts } from './_lib/data.js';

export const meta = { title: 'Products' };

export default async function Page() {
  const products = await getProducts();
  return <ul>{products.map((p) => <li key={p.id}>{p.name}</li>)}</ul>;
}

Run it

velocits dev discovers app/, compiles the stylesheet, bundles, type-checks and restarts on change. velocits build additionally prerenders every page it can reach.
velocits dev
velocits build && velocits start

URL in use: /docs/getting-started — matched by [[...slug]], an optional catch-all.