Quick Start

Get OpenGPEX running on your local machine in under 5 minutes.

Prerequisites

• Node.js 20+ (LTS recommended)
• pnpm 9+ (package manager)

1. Clone the Repository

git clone https://github.com/opengpex/opengpex.git
cd opengpex

2. Install Dependencies

pnpm install

3. Start the Development Server

pnpm dev

The editor will be available at http://localhost:3030.

4. Load an Image

1. Open the editor in your browser
2. Drag and drop any image file onto the canvas, or use the file upload button
3. Start editing!

5. Build for Production

pnpm build

For Cloudflare Workers deployment:

pnpm cf-build

6. (Optional) Connect to GPEX-Cloud

To enable cloud storage features, create a .env.local file:

NEXT_PUBLIC_GPEX_CLOUD_API_URL=https://your-cloud-instance.com/api

Then sign in via the editor's cloud menu to save/load projects remotely.

Next Steps

• Project Structure — Understand the codebase layout
• Editor Overview — Learn the UI and workspace
• Plugin System Overview — Build your first plugin

Last updated: 2026-06-14