Skip to content

QUICK_START.md

Latest commit

 

History

History
127 lines (97 loc) · 3.29 KB

QUICK_START.md

File metadata and controls

127 lines (97 loc) · 3.29 KB

NodeDeck Quick Start Guide

🚀 Get Started in 3 Minutes

For Users (Just Want to Use It)

Download & Run:

  1. Download NodeDeck-1.0.0-arm64.dmg from the releases
  2. Double-click to install → Drag to Applications
  3. Launch NodeDeck → Click menu bar icon → Scan QR code
  4. Done! Control your Mac from your phone 📱

For Developers (Build from Source)

One Command Build:

git clone <repo-url> && cd nodedeck && npm run install:all && npm run dist:mac

Result: Find your app at nodedeck-electron/dist/NodeDeck-1.0.0-arm64.dmg

📋 Available Scripts

🏗️ Build Commands

npm run dist:mac        # Build macOS app (DMG + App bundle)
npm run dist:win        # Build Windows installer  
npm run dist:linux      # Build Linux packages
npm run dist            # Build for current platform

🛠️ Development Commands

npm run dev:electron    # Run Electron app in development
npm run dev:server      # Run standalone server
npm run dev:client      # Run React client dev server

🧹 Utility Commands

npm run install:all     # Install all dependencies
npm run build:all       # Build client + Electron (no packaging)
npm run clean           # Clean all build artifacts

🎯 Common Workflows

First Time Setup

git clone <repository-url>
cd nodedeck
npm run install:all     # Install all dependencies
npm run dist:mac        # Build distributable app

Daily Development

npm run dev:electron    # Launch app in dev mode
# Make changes, app auto-reloads

Production Build

npm run clean           # Clean previous builds
npm run dist:mac        # Create fresh build

Testing Builds

npm run build:all       # Quick build test (no packaging)
npm run pack:mac        # Create unpacked app (faster than DMG)

⚡ Performance Tips

Faster Builds:

  • Use npm run pack:mac instead of npm run dist:mac for development
  • Only run npm run dist:mac for final releases (DMG creation is slow)
  • Use npm run build:all to test builds without packaging

Parallel Development:

# Terminal 1: Client hot reload
cd nodedeck-client && npm run dev

# Terminal 2: Server auto-restart  
cd nodedeck-server && npm run dev

# Terminal 3: Electron development
cd nodedeck-electron && npm run dev

🔧 Troubleshooting

Build fails?

npm run clean && rm -rf node_modules */node_modules && npm run install:all

App won't start?

cd nodedeck-electron && npm rebuild

Permission errors?

  • Launch the app, it will guide you through fixing permissions
  • Or go to: System Settings > Security & Privacy > Accessibility

📁 Output Locations

After npm run dist:mac:

  • DMG Installer: nodedeck-electron/dist/NodeDeck-1.0.0-arm64.dmg
  • App Bundle: nodedeck-electron/dist/mac-arm64/NodeDeck.app
  • Built Client: nodedeck-server/public/ (also copied to nodedeck-electron/public/)

🎮 How to Use

  1. Install the built DMG file
  2. Launch NodeDeck (appears in menu bar)
  3. Click the tray icon to show QR code
  4. Scan QR code with your phone
  5. Add to Home Screen (PWA) for best experience
  6. Control your Mac with 12 function buttons!

Need more details? See BUILD.md for comprehensive documentation.