Skip to main content

Quick Start

Quick Start — ɳSelf documentation.

Full backend running in five minutes. Postgres, GraphQL, Auth, and Nginx — on your machine or any server.

1. Install

macOS:

brew install nself-org/nself/nself

Linux / WSL:

curl -sSL https://install.nself.org | bash

After install, verify:

nself version

2. Initialize

nself init myapp

The wizard asks four questions. Accept the defaults for local dev.

PromptDefault
Project namemyapp
Base domainlocalhost
Services to enablePostgres, Hasura, Auth, Nginx
Postgres passwordAuto-generated

Skip all prompts: nself init myapp --fast

3. Build

nself build

Generates docker-compose.yml, Nginx config, and SSL certs. Takes a few seconds.

4. Start

nself start

Boots in dependency order. Each service prints its status:

✓ postgres   healthy (2s)
✓ hasura     healthy (8s)
✓ auth       healthy (5s)
✓ nginx      healthy (1s)

5. Check your URLs

nself urls
Service        URL
─────────────────────────────────────────
Hasura         https://hasura.localhost
Auth           https://auth.localhost
GraphQL API    https://api.localhost/v1/graphql

Open the Hasura console and run a query to confirm the API is live:

query { __typename }

6. Stop

nself stop

Shuts down cleanly. Docker volumes keep your data.

Next: First Project · Add plugins · Configuration