Help & documentation

Guides, keyboard shortcuts and answers to the questions that come up most.

Documentation

  • Getting started

    Install, run and take the tour of every page.

    docs/getting-started.md
  • Connect your API

    Swap the demo data for your backend using the adapter layer.

    docs/api-integration.md
  • Branding & white-label

    Logo, colours, currency and naming.

    docs/branding.md
  • Configuration

    Environment variables, feature flags and modules.

    docs/configuration.md
  • Troubleshooting

    Common problems and how to resolve them.

    docs/troubleshooting.md
  • Support

    What support covers and how to report an issue.

    docs/support.md

Full documentation ships in the docs/ folder of the source package.

Frequently asked questions

Where does the data come from?
Out of the box, from a deterministic demo dataset generated in the browser. Point the app at your own REST API in Settings → Data source, or implement the DataAdapter interface for anything else.
Can I remove pages I don't need?
Yes. Switch a module off in Settings → Modules and it disappears from navigation and its route is blocked. To remove it permanently, delete the route folder and its navigation entry.
How do exports work?
Exports are generated in the browser from the data already loaded. CSV and Excel-compatible CSV download directly; PDF uses the browser print dialog with a print stylesheet.
Is there authentication?
The template is auth-ready but ships with a demo provider. Replace src/providers/auth-provider.tsx with your identity provider; roles and permissions flow from there into navigation.
Are the numbers real?
No. Northstar Holdings is fictional and every figure is generated for demonstration. The ledger is double-entry and internally consistent so reports reconcile.

Keyboard shortcuts

Work faster without the mouse

  • Open global search⌘ K / Ctrl K
  • Move through search results↑ ↓
  • Open the highlighted resultEnter
  • Close a dialog or drawerEsc
  • Print the current report to PDF⌘ P / Ctrl P