FAQ

Do I need a back end or a database? No. The template renders static demo data and runs as a static site. Connect your own API when you build your application.

Why does a page return 404 when I reload it on my server? The server needs the SPA fallback: every path that is not a file must return index.html. See Installation for Netlify, Vercel, Nginx, Apache and Docker.

Can I deploy it in a sub-folder? Yes: ORBIX_BASE=/admin/ npm run build (see Installation).

Is there server-side rendering (Nuxt)? This item is the Vue + Vite edition: a client-side single-page app. The fd-* markup, the components and the styles work in any Vue 3 setup, but the routing and the build are written for Vite and Vue Router.

Does it use the Options API or the Composition API? The Composition API with <script setup lang="ts"> in every component. You can still write Options API components of your own; Vue supports both.

Does it use Pinia or Vuex? No store is needed by the template: the page data lives in the route table, the theme and the language in their runtimes. Add Pinia when your application needs shared state (npm install pinia, then app.use(createPinia()) in src/main.ts).

Does it use jQuery or a CDN? No. Every script and style is compiled locally with Vite. There are no external requests.

Is TypeScript required? The template is written in strict TypeScript and npm test runs the vue-tsc type check. You can write <script setup> blocks without lang="ts" if you prefer, but typed props catch most mistakes when you change a component.

How do I change the logo and the app name? The logo is the brand block in src/components/shell/Brand.vue: change the name there, and replace the ox-i-mark symbol in src/svg/orbix-icons.svg with your own SVG, then run npm run assets. The document title suffix is in src/layouts/usePageDocument.ts and index.html; the favicon is public/favicon.svg.

How do I change the default language? The language comes from the user's saved choice, then from <html lang> in index.html (en). Change it there (es, pt, fr or ar; for Arabic also set dir="rtl").

How do I remove a language? See Languages.

How do I make dark mode the default? initTheme({ product: { mode: 'dark' } }) in src/main.ts (see Theming).

Why do the icons I added not show? Run npm run assets (or npm run dev / npm run build): only the icons referenced in src/ are added to the sprite.

Can I use Vue state, v-model and my own composables in the pages? Yes. The pages are regular single-file components: add refs, computed values, watchers, data fetching and event handlers as usual. The demo pages keep their interactions in small page scripts (src/scripts/) so that the markup stays identical across the Orbix editions.

Why is there one v-html in the template? The command palette reads its quick actions from a <template> element whose content (a separate document fragment) a Vue render cannot fill. src/components/shell/CommandPalette.vue sets that static markup with v-html; nothing else uses raw HTML, and the test suite checks it.

Can I use Orbix for a SaaS where my customers pay? Yes, with the Extended License. The Regular License covers one end product whose users are not charged.

Where are the source images of the illustrations? The illustrations are inline SVG inside the auth and status components; edit their colors with the design tokens.

Can I use the demo photos in my product? Yes. They are CC0 1.0 or public domain (credits in public/images/CREDITS.json and licensing.txt). To use your own, replace the files in public/images with WebP or JPEG images of the same size, or change the src in the components; avatars fall back to initials when there is no photo.