A modern desktop application for the Hashgraph Online Conversational Agent, built with Electron, React, and TypeScript.

⚠️ ALPHA SOFTWARE WARNING ⚠️

This is an alpha version. By using this software, you acknowledge:

• AI models make mistakes and may suggest incorrect transactions
• Blockchain transactions are irreversible once executed
• You could lose funds if you approve incorrect transactions
• Use testnet for experimentation (mainnet at your own risk)

USE AT YOUR OWN RISK

• Node.js 18+ (20+ recommended)
• pnpm 8+ (auto-installed by setup script if missing)
• Git

# Clone the repository
git clone https://github.com/hashgraph-online/desktop
cd desktop/app

# Quick setup and run development mode
./setup.sh --dev

This will:

1. Check requirements
2. Setup legal files
3. Install dependencies
4. Start the app in development mode with hot reload

# Clone repository
git clone https://github.com/hashgraph-online/desktop
cd desktop/app

# Setup legal files
cp terms.md.example terms.md
cp privacy.md.example privacy.md
mkdir -p public
cp terms.md.example public/terms.md
cp privacy.md.example public/privacy.md

# Install dependencies and start dev mode
pnpm install
pnpm dev  # or pnpm start

# Run the interactive setup
./setup.sh

# Or run full setup + build
./setup.sh --full    # Complete setup + build for distribution

Setup Script Options:

The app requires terms of service and privacy policy files:

Important: Customize these files for your organization before distribution!

pnpm dev         # Starts Electron app in dev mode (RECOMMENDED)
# or
pnpm start       # Same as above

pnpm dev:log     # Starts Electron app with comprehensive logging

Development Mode Features:

• ✅ Auto-opens Electron window
• ✅ Runs on http://localhost:5173 (Vite dev server)
• ✅ Hot module replacement enabled
• ✅ DevTools available for debugging
• ✅ Auto-restart on code changes
• ✅ All dependencies available (including local file dependencies)

Logging Mode Features (pnpm dev:log):

• ✅ All development mode features above
• ✅ Runs on http://localhost:5174 (different port to avoid conflicts)
• ✅ Comprehensive logging to dev.log file
• ✅ Can run alongside regular dev server
• ✅ Timestamps and formatted log output for debugging

pnpm test          # Run tests
pnpm test:watch    # Run tests in watch mode
pnpm test:coverage # Run tests with coverage
pnpm typecheck     # Type checking
pnpm storybook     # View component stories

Note: For development and testing, use pnpm dev instead. Building is only needed when creating distributable packages.

# Step 1: Build the application
pnpm build

# Step 2: Create distribution package for your platform
pnpm dist:mac     # macOS distribution
pnpm dist:win     # Windows distribution
pnpm dist:linux   # Linux distribution

# Or use setup script (auto-detects platform)
./setup.sh --build

out/
├── Hashgraph Online-{platform}-{arch}/
│   ├── Hashgraph Online.app     # macOS executable
│   ├── Hashgraph Online.exe     # Windows executable
│   └── hashgraph-online         # Linux executable
│
└── make/                         # Distribution packages
    ├── zip/                      # macOS
    │   └── darwin/
    │       └── {arch}/
    │           └── *.zip         # Distributable ZIP
    │
    ├── squirrel.windows/         # Windows
    │   └── {arch}/
    │       └── *.exe             # Setup installer
    │
    └── deb/                      # Linux
        └── {arch}/
            └── *.deb             # Debian package

Installation: Unzip and drag .app to Applications folder

Note: The .app file in out/ is for testing purposes. For production use, always distribute the .zip package from out/make/. For development and testing, use pnpm dev for the best experience with hot reload.

Installation: Run the installer .exe

Installation:

• AppImage: Make executable and run
• Deb: sudo dpkg -i package.deb

The app requires configuration of:

• Account ID (format: 0.0.xxxxx)
• Private Key (ED25519 or ECDSA)
• OpenAI API Key (starts with sk-)
• Network selection (Testnet only by default)
  • Note: Mainnet can be enabled by setting ENABLE_MAINNET=true environment variable. During the alpha phase, it is heavily recommended to use testnet ONLY. Enabling mainnet can be done at your own risk. Please be advised that AI models do make mistakes and blockchain transactions are irreversible.

• API Key (starts with sk-)
• Model selection (gpt-4o, gpt-4, gpt-3.5-turbo)

• Filesystem access
• GitHub integration
• Database connections
• Custom servers

# macOS/Linux
ENABLE_MAINNET=true pnpm dev

# Windows
set ENABLE_MAINNET=true && pnpm dev

# macOS/Linux
ENABLE_MAINNET=true pnpm build

# Windows
set ENABLE_MAINNET=true && pnpm build

• Native addons must be unpacked from ASAR. We configure:
  • forge.config.ts → packagerConfig.asar = { unpack: '**/*.node' }
• Reference: Electron: Using native Node modules

app/
├── src/
│   ├── main/              # Electron main process
│   ├── preload/           # Preload scripts
│   └── renderer/          # React application
│       ├── components/    # UI components
│       ├── pages/         # App pages
│       └── store/         # State management
│
├── scripts/
│   ├── setup-legal.js     # Legal files setup (Node.js)
│   └── prepare-icons.js   # Icon generation script
│
├── setup.sh               # Automated setup script (Bash)
├── terms.md.example       # Terms template
├── privacy.md.example     # Privacy template
├── package.json           # Project configuration
└── forge.config.ts        # Electron Forge config

• Electron - Cross-platform desktop framework
• React - UI library
• Vite - Build tool & dev server
• TypeScript - Type safety
• Tailwind CSS - Styling
• Zustand - State management
• @hashgraphonline/conversational-agent - AI agent library

• macOS 10.15+ (Catalina or later)
• Apple Silicon (M1/M2/M3) or Intel processor

• Windows 10 or later
• 64-bit processor

• Ubuntu 18.04+, Fedora 32+, Debian 10+
• 64-bit processor

We welcome contributions. See CONTRIBUTING.md for guidelines.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/your-feature)
3. Make your changes
4. Run tests (pnpm test)
5. Commit with DCO sign-off (git commit -s)
6. Submit a pull request

• TypeScript for type safety
• React hooks for state management
• Tailwind for styling
• JSDoc for function documentation
• No console.log statements
• Test your changes on testnet first