Installation

The steps are the same for orbix-nuxt/ (full template) and orbix-nuxt-starterkit/ (starter kit).

1. Copy the project

Extract the ZIP and copy orbix-nuxt/ to your projects folder (rename it as you like). Open a terminal in that folder.

2. Install the dependencies

npm install

The design system is installed from the local folder packages/foundry-ui/ (no registry account needed). npm ci installs the exact versions of package-lock.json (recommended in CI and Docker).

3. Run the dev server

npm run dev

Open http://localhost:3000. Edits to pages, components, styles and translations appear instantly (hot module replacement).

4. Build for production

npm run build

dist/bootstrap/ now holds the whole site: one index.html per page in a folder named like its URL (apps/kanban/index.html), 404.html and 200.html (single-page fallbacks), the hashed CSS and JavaScript in _nuxt/ (with the font files and their licenses), the demo photos in images/, the icon sets in icon-sets/ and favicon.svg. Every page is real HTML rendered at build time (in English; the saved language is applied in the browser). Check it locally with npm run preview.

5. Run the tests (optional)

npm run build        # the build suite checks the generated site
npm test

Deploy

Choose one of the two outputs:

Static hosts

Upload the contents of dist/bootstrap/. Every page has its own index.html, so no rewrite rules are needed; set 404.html as the error page so that unknown URLs show the Orbix 404 page.

• Netlify: build command npm run build, publish directory dist/bootstrap. 404.html is used automatically.
• Vercel: framework preset "Other", build command npm run build, output directory dist/bootstrap.
• Cloudflare Pages: build command npm run build, output directory dist/bootstrap. 404.html is used automatically.
• GitHub Pages: publish dist/bootstrap and add an empty .nojekyll file next to index.html (otherwise the _nuxt/ folder is ignored). 404.html is used automatically.
• S3 + CloudFront: upload the folder, set index.html as the default root object, 404.html as the error document (S3 website hosting) or a custom error response (CloudFront: 404 → /404.html, status 404).

Nginx

server {
  listen 80;
  server_name admin.example.com;
  root /var/www/orbix;            # contents of dist/bootstrap
  index index.html;

  location / {
    try_files $uri $uri/ $uri/index.html =404;
  }
  error_page 404 /404.html;

  location /_nuxt/ {
    expires 1y;
    add_header Cache-Control "public, immutable";
  }
}

Apache

In the virtual host or an .htaccess file next to index.html:

DirectoryIndex index.html
ErrorDocument 404 /404.html

IIS

Add index.html as a default document and a custom error page for 404 (/404.html, response mode "ExecuteURL").

Sub-folder

To serve the site from a sub-folder (for example https://example.com/admin/), build with the base path:

ORBIX_BASE=/admin/ npm run build          # Windows PowerShell: $env:ORBIX_BASE="/admin/"; npm run build

The base path is Nuxt's app.baseURL (set in nuxt.config.ts from ORBIX_BASE): routes, every <AppLink>, image and asset URL follow it. Upload dist/bootstrap into the admin/ folder and point the error page to /admin/404.html (Nginx: error_page 404 /admin/404.html;, Apache: ErrorDocument 404 /admin/404.html). To check it locally: ORBIX_BASE=/admin/ npm run preview and open http://localhost:4173/admin/.

Node.js server

npm run build:server      # .output/ (self-contained: no node_modules needed on the server)
npm start                 # or: NODE_ENV=production node .output/server/index.mjs

The server renders each page on request and answers unknown URLs with the 404 page and status 404. It listens on port 3000; set PORT and HOST to change it (PORT=8080 npm start). Copy the .output/ folder to your server and run it with a process manager (systemd, PM2) or in Docker (below), behind a reverse proxy for TLS. Build with ORBIX_BASE=/admin/ to serve it from a sub-folder.

Docker

Static site served by Nginx – save as Dockerfile in the project folder:

# Build
FROM node:24-alpine AS build
WORKDIR /app
COPY . .
RUN npm ci && npm run build

# Serve
FROM nginx:alpine
COPY nginx.conf /etc/nginx/conf.d/default.conf
COPY --from=build /app/dist/bootstrap /usr/share/nginx/html
EXPOSE 80

and nginx.conf next to it:

server {
  listen 80;
  root /usr/share/nginx/html;
  index index.html;
  location / { try_files $uri $uri/ $uri/index.html =404; }
  error_page 404 /404.html;
  location /_nuxt/ { expires 1y; add_header Cache-Control "public, immutable"; }
}

Then docker build -t orbix-admin . and docker run -p 8080:80 orbix-admin (open http://localhost:8080).

Node.js server – the server build needs only Node.js at run time:

FROM node:24-alpine AS build
WORKDIR /app
COPY . .
RUN npm ci && npm run build:server

FROM node:24-alpine
WORKDIR /app
COPY --from=build /app/.output ./.output
ENV NODE_ENV=production PORT=3000
EXPOSE 3000
CMD ["node", ".output/server/index.mjs"]

docker build -t orbix-admin . and docker run -p 3000:3000 orbix-admin. Add a .dockerignore with node_modules, .nuxt, .output and dist to keep the build context small.

Troubleshooting