Quickstart

The bootstrap flow is still evolving. This page documents the current direction rather than a final interface.

1. Clone the repository

bash
git clone <official-repository>
cd nodabase

<official-repository> is a placeholder — use the official Nodabase repository URL.

The repository contains the Docker Compose stack and most of the default environment configuration.

2. Configure the environment

Open the root .env in the repository and set the path to your Node.js application or project:

env
APP_PATH=/path/to/your/node-project

This one is yours to provide. The Nodabase runtime uses that path to run the application, so it has to point at an existing Node.js project on the machine where you run the platform.

3. Start the platform

bash
docker compose up -d

This brings up the services in the Compose stack: the database, authentication, cache, storage, queues, jobs, control plane and dashboard.

4. Install the client in your application

bash
npm install nodabase

5. Use the platform from Node.js

js
import { nodabase } from "nodabase";
 
const { rows } = await nodabase.db.query(
"SELECT NOW() AS time"
);
 
console.log(rows[0]);

The basic flow

Node.js application
         |
         v
Nodabase runtime
         |
         v
Nodabase services

Your application runs as a Node.js process, the Nodabase runtime runs it on your infrastructure, and the client reaches the platform services that are backed by PostgreSQL, GoTrue, Dragonfly, MinIO, NATS and the Job Runner.

Notes on this flow

The current bootstrap flow is still evolving, and a future nodabase init CLI may simplify the process. Until then, cloning the repository, setting APP_PATH and starting Compose is the intended path.

Service documentation