1. Application Overview

1.1 What is NkapBooks?

NkapBooks is a modern, offline-first desktop accounting application designed for small and medium businesses, freelancers, and entrepreneurs. It provides a complete suite of financial management tools — from invoicing, inventory management, and point-of-sale to double-entry accounting and comprehensive reporting — all running natively on your desktop.

Built with a philosophy of simplicity and accessibility, NkapBooks eliminates the need for an accounting degree. Its clean, intuitive interface guides users through every financial workflow while maintaining the rigor of professional double-entry bookkeeping under the hood.

Core Philosophy

• Privacy First — All data is stored locally on your machine. No cloud dependency, no third-party data access.
• No Internet Required — Full functionality without an internet connection.
• Professional Grade — Double-entry accounting ensures accuracy and compliance.
• Accessible to Everyone — Designed so that anyone can manage their business finances without specialized training.

1.2 Key Highlights

1.3 Technology Stack

NkapBooks is built with a modern, production-grade technology stack:

Architecture Overview

┌──────────────────────────────────────────────────────┐
│                    Tauri Shell (Rust)                 │
│  ┌────────────┐  ┌──────────┐  ┌──────────────────┐  │
│  │  Updater   │  │   FS     │  │   Stronghold     │  │
│  │  Plugin    │  │  Plugin  │  │   (Encrypted)    │  │
│  └────────────┘  └──────────┘  └──────────────────┘  │
├──────────────────────────────────────────────────────┤
│                 Vue.js 3 Frontend                     │
│  ┌──────────┐  ┌───────────┐  ┌──────────────────┐  │
│  │  Pages   │  │Components │  │   Composables    │  │
│  │ Dashboard │  │ Sidebar   │  │  useAuth         │  │
│  │ POS      │  │ FormCtrl  │  │  useSessionMgr   │  │
│  │ Reports  │  │ PrintView │  │  useLicense       │  │
│  └──────────┘  └───────────┘  └──────────────────┘  │
├──────────────────────────────────────────────────────┤
│                  Fyo Core Layer                       │
│  ┌──────────┐ ┌─────────┐ ┌─────────┐ ┌──────────┐ │
│  │DatabaseH.│ │  DocH.  │ │  Auth   │ │  Perm    │ │
│  │(DB Demux)│ │(Models) │ │ Service │ │ Manager  │ │
│  └────┬─────┘ └─────────┘ └─────────┘ └──────────┘ │
│       │                                              │
│  ┌────┴──────────────┬───────────────────┐           │
│  │     SQLite        │    PostgreSQL     │           │
│  │   (Local .db)     │   (Remote Server) │           │
│  └───────────────────┴───────────────────┘           │
└──────────────────────────────────────────────────────┘

Key Internal Services (Fyo Singleton)

The global Fyo instance is the heart of NkapBooks. It orchestrates all core services:

1.4 Application Screens & Lifecycle

When NkapBooks launches, it progresses through a series of screens depending on the state of the user's data:

1. Database Selector — Shown on first launch or when no previous database is remembered. Allows the user to create a new company (SQLite or PostgreSQL), open an existing .db file, or connect to a PostgreSQL server.
2. Setup Wizard — Shown when a new database is created. Collects company name, admin credentials (full name, email, username, password), country, currency, bank name, chart of accounts template, and fiscal year dates. Displays a 7-stage progress overlay during setup.
3. Login — Shown when authentication is required (SystemSettings.requireAuth is enabled). Supports email/username + password login, "Remember me", password reset, language switching, and dark mode toggle. Can optionally be skipped if allowSkipAuth is enabled.
4. Desk — The main application interface. Contains the collapsible sidebar (with navigation groups for Get Started, Dashboard, Sales, Purchases, Common Entries, POS, Inventory, Reports, and Setup) and the main content area with router views.
5. Session Lock — Activated when the user's session times out due to inactivity (configurable via SystemSettings.sessionTimeout, default 60 minutes). Requires re-authentication to unlock.

Sidebar Navigation Structure

The sidebar is organized into the following groups (visibility is controlled by role-based permissions and feature flags):

Items marked with * are shown only when their corresponding feature flag is enabled in Accounting Settings.

Sidebar Footer

The sidebar footer provides quick access to:

• Subscription — View and manage your license/subscription status
• User Profile — View logged-in user name, access User Settings, or Sign Out
• Language Switcher — Change the application language at any time
• Theme Toggle — Switch between Light Mode and Dark Mode with an animated ripple transition
• Shortcuts — Open the keyboard shortcuts reference modal