Skip to content

author-more/penpot-desktop

Repository files navigation

Penpot Desktop

Penpot Desktop

Penpot Desktop is an unofficial desktop application for the open-source design tool, Penpot.

It provides you with access to the functionality of the browser version of Penpot with an experience of a desktop application. It comes with

  • system-level application experience e.g. a dedicated window, file extension association,
  • versatile dark-light mode setup,
  • tab interface for easy navigation between projects,
  • ability to connect to different instances e.g. officially hosted, local for offline work,
  • and more are coming.

Quick Links

Development and Building

  1. Ensure the environment meets the following requirements:

    • Supported OS:
      • Windows 10 or newer
      • macOS
      • Linux
    • NodeJS v20
    • Python
    • Git (optional)
  2. Clone the repository or download the source code.

  3. Navigate to the project's directory.

  4. Run npm ci to install packages. Other package managers such as Yarn, PNPM, or Bun should work as well.

  5. (Optional) Run npm run setup to prepare development environment.

  6. (Optional) Run npm run dev to start the application in development mode. This will open a new window with the application running.

    Note: Penpot Desktop is using ES Modules. Make sure to read the ES Modules (ESM) in Electron guide.

  7. Run npm run build to build the application. By default, it will build for the current OS and architecture, but you can pass flags to build for other platforms. See the Electron Builder documentation for more information.