Skip to content

About

The Showcode desktop application

Resources

Stars

7 stars

Watchers

1 watching

Forks

Repository files navigation

Create beautiful images of code.

Showcode Desktop

The cross-platform desktop application for Showcode, built with Electron.

This repository wraps the Showcode web application as a native desktop app for macOS, Windows, and Linux.

Download

Pre-built binaries are available on the releases page and at showcode.app/buy.

Repository Structure

showcode-app/
├── main/           Electron main process (window management, IPC, protocol handling)
├── build/          Icons and platform-specific build assets
├── extraResources/ Additional resources bundled with the app
└── showcode/       Git submodule containing the Nuxt application (the renderer)

The renderer (UI) lives in the showcode submodule and is shared with the web version.

Requirements

Local Development

Clone the repository including submodules:

git clone --recurse-submodules https://github.com/stevebauman/showcode-app.git
cd showcode-app

If you've already cloned without --recurse-submodules:

git submodule update --init --recursive

Install dependencies for both the Electron host and the Nuxt renderer:

npm install
(cd showcode && npm install)

Start the development environment (Nuxt dev server + Electron with HMR):

npm run dev

This concurrently runs the Nuxt dev server on http://localhost:3000 and launches Electron pointed at it. Changes to the renderer hot-reload automatically; changes to the main process require restarting the command.

Building

For the automated release flow and required GitHub configuration, see the release guide. For a local preview in one command, run npm run release:local.

To produce a distributable build for your current platform:

npm run generate    # builds the Nuxt renderer into showcode/.output/public
npm run build       # packages the Electron app via electron-builder

Output is written to dist/.

Code Signing & Notarization (macOS)

Electron-builder signs and notarizes production macOS builds with Apple. To build and notarize locally, copy electron-builder.env-example to electron-builder.env and populate the following values.

APPLE_ID=your-apple-id@example.com
APPLE_APP_SPECIFIC_PASSWORD=your-app-specific-password
APPLE_TEAM_ID=YOURTEAMID
CSC_LINK=./certificate.p12
CSC_KEY_PASSWORD=your-cert-password

Notarization requires a valid Apple Developer account and an app-specific password generated at appleid.apple.com. The certificate.p12 file is your Developer ID Application certificate exported from Keychain Access.

Unsigned builds will still run locally but will not pass Gatekeeper on other machines.

CI Builds

The build.yml workflow produces signed builds for macOS, Windows, and Linux on demand via workflow_dispatch. It expects the following repository secrets to be set:

Secret Purpose
APPLE_ID Apple ID email
APPLE_ID_PASSWORD App-specific password
APPLE_TEAM_ID Apple Developer Team ID
CSC_LINK Base64-encoded .p12 certificate
CSC_KEY_PASSWORD Certificate password

The workflow passes the APPLE_ID_PASSWORD secret to electron-builder as APPLE_APP_SPECIFIC_PASSWORD.

Contributing

Contributions are welcome. The repository is split across two projects:

  • UI / renderer changes belong in the showcode submodule.
  • Window, menu, IPC, packaging, or installer changes belong in this repository.

Please open an issue before starting on significant changes so we can discuss the approach.

License

MIT © Steve Bauman

About

The Showcode desktop application

Resources

Stars

7 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages