Quick Start
Quick Start
Get a complete backend running on your machine in less than a minute.
1. Instant Launch with NPX
Run the following command in any terminal:
npx @nodestackapp/server start
This immediately:
- Provisions embedded SQLite database files in
./nodestack_data/. - Starts the HTTP Fastify server on
http://127.0.0.1:8090. - Serves the embedded Web Admin Dashboard at
http://127.0.0.1:8090/_/.
2. First-Run Admin Onboarding
- Open your browser and navigate to:
http://localhost:8090/_/
- You will be greeted by the First-Run Setup Screen.
- Create your initial Superuser credentials (email and password).
Alternatively, you can create the first superuser directly via the CLI:
npx @nodestackapp/server superuser create admin@example.com MySecretPassword123!
3. Create Your First Collection
Inside the Web Admin Dashboard:
- Click + New Collection in the left sidebar.
- Enter a collection name (e.g.
articles). - Add fields:
title(Text)content(Text, toggle Enable FTS5 for full-text search)published(Bool)cover(File)
- Click Create Collection.
NodeStack immediately creates:
- The SQLite table
articles. - The SQLite FTS5 index
_fts_articles(if FTS is enabled). - REST endpoints:
GET,POST,PATCH,DELETEat/api/collections/articles/records. - Real-time SSE change subscription channel at
/api/realtime.
4. Query Records via REST API
Create a record with cURL:
curl -X POST http://localhost:8090/api/collections/articles/records \
-H "Content-Type: application/json" \
-d '{"title": "Getting Started with NodeStack", "content": "NodeStack is fast and simple."}'
Query records with search and pagination:
curl "http://localhost:8090/api/collections/articles/records?page=1&perPage=10&search=NodeStack"
5. Next Steps
- Connect using the First-Party Client SDK.
- Configure Visual Access Rules to secure your collections.
- Set up Outbound Webhooks to notify third-party services.