Getting started

Requirements

• Node.js 20 or newer (22 LTS recommended)
• npm 10+ (or pnpm/yarn/bun — lockfile provided for npm)

Install and run

npm install
npm run dev

The app starts at http://localhost:3000 and redirects to /dashboard. It runs entirely on the bundled demo dataset, so there is nothing else to configure.

Scripts

A tour of the app

Dashboard (/dashboard) — eight KPI cards with sparklines and period comparison, revenue versus expenses, cash balance, revenue by department, expenses by category, top customers and vendors, ageing comparison, budget progress and recent transactions. Most widgets are clickable and open a drill-down drawer.

Analytics

• Revenue — total and growth, trend against the comparison baseline, and a breakdown table across six dimensions (department, branch, product, customer, region, channel).
• Expenses — spend by category, department and vendor, budget variance bars, and anomaly cards flagging charges well above their category average.
• Profitability — the full margin ladder (gross, operating, EBITDA, net) with margin trends and profitability by branch, department, product and customer.
• Cash flow — opening balance, inflows, outflows, net movement, closing balance, activity split and a detail table.

Reports

• Profit & loss, Balance sheet, Cash flow statement — hierarchical statements with comparative period, variance columns, expandable sections and account-level drill-through.
• General ledger — every posted line with a running balance, server-side pagination and search.
• Trial balance — opening, movement and closing columns with an in-balance indicator.
• Accounts receivable / payable — ageing donut, balances by party, and a document table with days-late and bucket columns.

Customers / Vendors — directory tables with revenue, orders and outstanding balance; detail pages add a revenue history chart, top products or categories, open documents and payment history.

Transactions — the full ledger with search, type and status filters, selection, export, and a drawer showing the complete double-entry journal for any line. Drill-downs deep-link here with filters applied.

Budget & forecast — plan versus actual by line and period (monthly, quarterly, yearly), variance table and a projection with a confidence band.

Inventory / cost — stock value, turnover, COGS, and fast/slow/dead stock tables.

Custom dashboard — add widgets from a 17-item library, reorder, resize and reset. Layout persists per browser.

Settings — general, branding, appearance, currency, date & time, modules, feature flags, data source, notifications, users & roles.

Help — documentation index, keyboard shortcuts and FAQs.

Keyboard shortcuts

Next steps

• Connect your backend: api-integration.md
• Rebrand: branding.md
• Turn modules off: configuration.md