Skip to content

Latest commit

 

History

138 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ArmoryVault

CI Website Docs Modules Release License

Live Website & Download Portal: https://cook0001.github.io/ArmoryVault/
Modules Registry Hub: https://cook0001.github.io/ArmoryVault-Modules/
Official User Guide & Knowledge Base: https://cook0001.github.io/ArmoryVault/#docs

A secure, premium, cross-platform desktop application designed for serious firearms owners, collectors, and reloaders. ArmoryVault provides local inventory tracking, maintenance schedules, ballistics calculations, and printable ATF "Bound Book" ledgers wrapped in a modern dark Glassmorphism interface.

Key Features

  • Lean Core & Pluggable Modular Architecture: Core essentials (Dashboard, Firearms, Ammunition Depot, Storage Organizer, Accessories, Vault Security) remain lean, fast, and 100% air-gapped. Specialized features are installed on-demand via the in-app Module Center (Reloading Workbench, Armorer & Maintenance, Ballistics Calculator, NFA Tracker, Bound Book, Optics Vault, Range Finder, and Batch Label Studio).
  • Typst Vector PDF Documentation Suite: Generates publication-grade multi-page Insurance Appraisal Binders and Official Armorer Work Order & Inspection Certificates in 0.14s using native Typst with 3-tier cloud & offline Chromium fallbacks.
  • Dedicated Modules Repository & Dynamic Discovery: Pluggable modules are maintained independently in cook0001/ArmoryVault-Modules. The core application queries the remote catalog and registers newly published extensions without requiring a core application re-compile.
  • Encrypted Module Archiving & Data Mobility: Uninstalled modules have their data pruned from memory and securely written to AES-256-GCM encrypted archives (userData/module_archives/). All module archives travel with your automated .zip backups so your historical records are never lost.
  • End-to-End Inventory Tracking: Log make, model, caliber, serial number, purchase price, storage locations, optic torque specs, and high-resolution local photos.
  • Maintenance & Round Telemetry: Keep detailed logs of gunsmithing work, deep cleanings, part replacements, and range sessions. Lifetime round counts increment dynamically across weapons and mounted accessories with proactive wear alerts.
  • ATF A&D Bound Book: Generate professional Acquisition & Disposition (A&D) ledger views specifically formatted for 27 CFR Part 478 compliance and optimized for standard 8.5x11 printing.
  • Interactive FFL & Shooting Range Pickers: Integrated directory lookup querying live ATF license records and 2,539 verified shooting facilities across all 50 states.
  • Local Wi-Fi Companion Sync: Securely pair and synchronize inventory telemetry with the ArmoryVault Mobile Companion app over local Wi-Fi with zero cloud relay servers.
  • 100% Private & Air-Gapped: Built with Electron, React 19, and Vite. Your data is encrypted locally with PBKDF2/AES-256-GCM. No accounts, no cloud servers, and zero third-party telemetry.

Tech Stack

  • Frontend: React 19, TypeScript, Vite, Biome
  • Styling: Vanilla CSS (Modern Dark Glassmorphism) with Lucide Vector Icons
  • Desktop Engine: Electron with secure context-isolated IPC bridge
  • Document Engine: Typst 0.15 native vector compiler with 3-tier resilient fallback
  • Testing: Vitest CI Suite (154 automated tests across 29 suites)
  • Storage: Native File-System & Encrypted AES-256-GCM persistence
  • CI/CD: electron-builder, electron-updater, and GitHub Pages

Installation

ArmoryVault is an open-source project distributed directly via GitHub Releases.

macOS

  1. Download ArmoryVault-Mac-arm64.dmg (Apple Silicon) or ArmoryVault-Mac-x64.dmg (Intel).
  2. Drag ArmoryVault.app into your Applications folder.
  3. If macOS Gatekeeper displays an unverified developer warning:
    • Open Terminal and run:
      xattr -cr /Applications/ArmoryVault.app
    • Alternatively, navigate to System Settings > Privacy & Security and click "Open Anyway".

Windows

  1. Download ArmoryVault-Setup-2.9.0.exe.
  2. Double-click the installer.
  3. If Microsoft Defender SmartScreen displays a warning, click "More info" followed by "Run anyway".

Linux (.AppImage)

  1. Download ArmoryVault-2.9.0.AppImage.
  2. Grant execution permissions:
    chmod +x ArmoryVault-2.9.0.AppImage && ./ArmoryVault-2.9.0.AppImage

Development Setup

To run ArmoryVault locally for development:

  1. Clone the repository:

    git clone https://github.com/cook0001/ArmoryVault.git
    cd ArmoryVault
  2. Install dependencies:

    npm install
  3. Start the Development Server:

    npm run electron:dev
  4. Run Linter & Test Suite:

    npm run check       # Biome formatting & linter check
    npm test            # Full Vitest automated test suite (25 suites, 147 tests)
    npm run build       # TypeScript compiler (tsc -b) & Vite production build

Detailed Developer Guide: See WORKFLOW.md for guidelines on code standards, atomic git commits, and release preparation.

Building for Production & Releases

Command Platform Output Target
npm run package:mac macOS Universal (.dmg + .zip) dist-electron/release/
npm run package:win Windows Setup (.exe) dist-electron/release/
npm run package:linux Linux Universal (.AppImage) dist-electron/release/
npm run package:modules Modular Extension Archives dist-modules/ (module-*.zip)
npm run release Multi-Platform Release Compiles and publishes release binaries

Automated CI/CD Pipeline

  • Continuous Integration (.github/workflows/ci.yml): Runs linting, type-checking, and all 147 unit tests on every pull request and push.
  • Desktop Releases (.github/workflows/release.yml): Builds cross-platform binaries and publishes assets to GitHub Releases.
  • Website Portal (.github/workflows/website.yml): Deploys the official portal to GitHub Pages.

Associated Repositories

License

Released under the ISC License. Copyright © 2026 Daniel C. (cook0001).

About

ArmoryVault is a app for people to use for at home tracking of Firearms, ammo, and accessories.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages