About this project

Penpot Desktop is an unofficial desktop application for the open-source design tool, Penpot. It wraps the Penpot web application in a native desktop experience, providing features like a dedicated window, file extension association, versatile dark-light mode setup, a tab interface for navigating between projects, and the ability to connect to different Penpot instances (e.g., officially hosted or local for offline work). It also includes a built-in local instance creator based on the official Docker setup, enabling offline use, and supports batch export of projects. ## Key Features - **Desktop Experience**: Dedicated window and system-level integration. - **Dark/Light Mode**: Versatile theme setup. - **Tab Interface**: Easy navigation between projects. - **Multi-Instance Support**: Connect to hosted or local Penpot instances. - **Local Instance Creator**: Set up and run a local Penpot instance via Docker for offline work. - **Batch Export**: Export projects in bulk. ## Development and Building ### Prerequisites - Supported OS: Windows, macOS, Linux - NodeJS - Git (optional) ### Steps 1. Clone the repository or download the source code. 2. Navigate to the project's directory. 3. Run `npm ci` to install packages (Yarn, PNPM, or Bun also work). 4. (Optional) Run `npm run setup` to prepare the development environment. 5. (Optional) Run `npm run dev` to start the application in development mode. 6. Run `npm run build` to build the application for the current OS/architecture, or pass flags for other platforms (see Electron Builder docs). Note: The project uses ES Modules; refer to the Electron ESM guide for details. ## Documentation - [Penpot](https://penpot.app/) - Official Penpot website - [Penpot Desktop Wiki](https://github.com/author-more/penpot-desktop/wiki) - Knowledge base - [Installation](https://github.com/author-more/penpot-desktop/wiki/Installation) - [Offline-use guide](https://github.com/author-more/penpot-desktop/wiki/Self%E2%80%90hosting)