Getting started

Quick Start

Go from zero to a deployed backend in under 5 minutes.

Step 1

1. Install the CLI

bash

# macOS / Linux
brew install novaabase/tap/novaabase

# Windows
scoop install novaabase

# Or via npm
npm install -g @novaabase/cli

Step 2

2. Create your project

Authenticate the CLI and provision a new project in your preferred region.

bash

novaabase login
novaabase projects create my-app --region us-east-1
novaabase link my-app

Step 3

3. Run a local stack

Boot Postgres, Auth, Storage and Functions on your machine.

bash

novaabase start
# Studio:  http://localhost:54323
# API:     http://localhost:54321
# DB URL:  postgresql://postgres:postgres@localhost:54322/postgres

Step 4

4. Make your first query

src/lib/nb.ts

import { createClient } from "@novaabase/client";

export const nb = createClient({
  url: import.meta.env.VITE_NOVAABASE_URL!,
  apiKey: import.meta.env.VITE_NOVAABASE_KEY!,
});

const { data, error } = await nb.from("todos").select("*");

Ship it

5. Deploy

bash

novaabase db push        # apply migrations
novaabase functions deploy hello
novaabase deploy --prod  # promote to production