Start a stack app

One application: pages, typed endpoints, background jobs and a database, which builds into a voidbase instance and deploys as a single Worker serving the site, the API and the admin panel from one address.

It is a Void app with an adapter added. The project stays a plain Void app the whole way through: the adapter generates the voidbase instance from it rather than asking you to keep one.

From an empty directory

bun add void
bunx void init          # asks which framework and starter; React and a database-backed one here
bun add @voidbase-cloud/voidbase

Then add the adapter to the Vite config, which is the only wiring there is:

// vite.config.ts
import { defineConfig } from "vite";
import { voidPlugin } from "void";
import { voidReact } from "@void/react/plugin";
import { voidbaseAdapter } from "@voidbase-cloud/voidbase/adapter/plugin";

export default defineConfig({ plugins: [voidPlugin(), voidReact(), voidbaseAdapter()] });

And ignore the two things that should never be committed: the generated instance, and the local values of your configuration.

.voidbase/
vb_secrets/secrets.json

What the project looks like

Everything above the gap is Void's and means what Void means by it. The three directories below it are the ones the adapter adds, each named for the voidbase thing it is, each optional, and each with its own page:

Build and run it

bun run build                                  # or: bunx --bun vite build
bun .voidbase/main.ts --http 127.0.0.1:8090    # site at /, API at /api, panel at /_/

The build writes a complete voidbase project into .voidbase/: your pages as its static files, your routes and hooks compiled into its hook bundle, your collections as its migrations. It is git-ignored, because it is output, and it is an ordinary instance in every other respect.

Deploy it

cd .voidbase && voidbase deploy

Everything on the project page applies from here: the same token and the same deploy. To have a push do it instead, so the site and its backend ship together on every commit, Deploy on every push is two commands and one dashboard step.

voidbase update

Two things that are different

Two databases, on purpose. Void's db/ is your application's own tables, in Drizzle, typed end to end, for the data your code owns. Collections are for the data the admin panel and the SDK own, with API rules and a schema someone can change without a deploy. Most apps want both, and vb_migrations is where the second kind is written down.

Routes and hooks are not the same thing. A route in routes/ is an endpoint you call. A hook in vb_hooks runs because a record changed, whoever changed it, including someone clicking in the admin panel. Reach for the first when you are writing an API, the second when a rule has to hold no matter who is writing.