Skip to the article
Aniq-UI

NorthstackDocs

Full Stack

Northstack documentation

Run your SaaS starter, set it up for your product, and find a fix when you need one.

Start with a local setup

Run Northstack on your own computer, step by step.

What the template is made of

A B2B SaaS starter in three apps: a public website that sells its licences, a multi-tenant workspace dashboard with platform administration, and the NestJS API behind both.

AppFolderPortWhat it is
Public websitewebsite/3030Next.js 16: the home page, the licences on the pricing page with their own checkout, documentation, the journal, the changelog, contact and the legal pages
Workspace dashboarddashboard/3031Next.js 16: sign-in, sign-up and onboarding; the workspace (overview, projects and their task boards, team and invitations, roles, billing, settings and API keys, activity, the AI assistant); the platform administration (overview, organizations, users, staff, platform roles and settings)
APIback-end/8000NestJS 12 and TypeORM, on SQLite locally and MySQL by configuration, every route under /api, the public /api/v1 for API keys, live permission updates and an MCP server

The folder also holds docker-compose.yml, which builds and starts all three with one command, and each app has its own Dockerfile.

What your package contains

The SaaS Website package is the public website on its own.

AppFolderPortWhat it is
Public websitewebsite/3030Next.js 16: the home page, the licences on the pricing page with their own checkout, documentation, the journal, the changelog, contact and the legal pages

Most of the site is its own content. Two parts call the Northstack API: the contact form and the licence checkout. With no API it runs on built-in sample data that answers both in the browser, so you can run it right away. The API and the dashboard are separate packages and are not in this download.

What your package contains

The Workspace Dashboard package is the dashboard on its own.

AppFolderPortWhat it is
Workspace dashboarddashboard/3031Next.js 16: sign-in, sign-up and onboarding; the workspace (overview, projects and their task boards, team and invitations, roles, billing, settings and API keys, activity, the AI assistant); the platform administration (overview, organizations, users, staff, platform roles and settings)

It has no data of its own: every screen reads and writes through the Northstack API. Until you point it at one, it runs on built-in sample data in your browser, so every screen works right away. The API and the public website are separate packages and are not in this download.

What your package contains

The Backend API package is the NestJS API on its own, with the database, the sample workspaces and every route the two frontends use.

AppFolderPortWhat it is
APIback-end/8000NestJS 12 and TypeORM, on SQLite locally and MySQL by configuration, every route under /api, the public /api/v1 for API keys, live permission updates and an MCP server

The public website and the workspace dashboard are separate packages and are not in this download. Any client can use the API over HTTP.

On Windows, use PowerShell or Git Bash for the commands in these guides.

Both frontends run in English and Arabic, with the Arabic interface laid out right to left, and in a light and a dark theme.

Browse the guides

13 guides in your download

Every guide ships in your download. Guides marked Included with your purchase are for buyers: sign in to read them online, or open them in your download.

Cookie Preferences

We use cookies to enhance your browsing experience, analyze site traffic, and personalize content. By clicking "Accept All", you consent to our use of cookies for analytics and personalized advertising.