markpdfdown-desktop: Instructions file for Codex

AGENTS.md - MarkPDFdown Desktop Development Guide

Build Commands

# Development
npm run dev                    # Run full dev environment (generates Prisma, starts Electron with IPC)

# Production Build
npm run build                  # Full production build (generates Prisma + builds Electron app)
npm run start                  # Preview production build (generates Prisma + previews Electron)

# Platform-specific builds, for the host architecture only (see "Native Modules and Packaging")
npm run build:win              # Build Windows NSIS installer
npm run build:mac              # Build macOS DMG
npm run build:linux            # Build Linux AppImage
npm run verify:package         # Check the packaged native modules (arch, presence, load test)
npm run verify:package:distros # Load the Linux package on other distros (needs Docker)

# Database
npm run generate               # Generate Prisma client (required after schema changes)
npm run migrate:dev            # Run migrations in development (creates/updates database)
npm run migrate:reset          # Reset database and re-run all migrations (WARNING: deletes all data)

# Other
npm run lint                   # Run ESLint with auto-fix on all .js/.jsx/.ts/.tsx files
npm run logo                   # Generate app icons from src/renderer/assets/logo.png to public/icons/

Environment Setup

Prerequisites

• Node.js: v18+ recommended (ESM support required)
• npm: v8+ (comes with Node.js)
• Git: For version control
• Platform-specific tools:
  • Windows: No additional tools needed
  • macOS: Xcode Command Line Tools
  • Linux: Standard build tools (build-essential on Debian/Ubuntu)

First-time Setup

# Clone repository
git clone <repository-url>
cd markpdfdown-desktop

# Install dependencies
npm install

# Generate Prisma client
npm run generate

# Run database migrations
npm run migrate:dev

# Start development server
npm run dev

Testing

本项目已配置完整的测试套件，使用 Vitest 作为测试框架。