diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..99068f7 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,73 @@ +name: penpot-tauri + +on: + push: + branches: [main] + pull_request: + branches: [main] + workflow_dispatch: + +permissions: + contents: write + +jobs: + build: + runs-on: ubuntu-24.04 + + steps: + - uses: actions/checkout@v4 + + - name: Install system dependencies + run: | + sudo apt-get update + sudo apt-get install -y \ + libwebkit2gtk-4.1-dev \ + build-essential \ + curl \ + wget \ + file \ + libxdo-dev \ + libssl-dev \ + libayatana-appindicator3-dev \ + librsvg2-dev + + - name: Install Rust stable + uses: dtolnay/rust-toolchain@stable + with: + components: clippy, rustfmt + + - name: Cache Cargo registry & build + uses: actions/cache@v4 + with: + path: | + ~/.cargo/registry + ~/.cargo/git + src/target + key: cargo-${{ runner.os }}-${{ hashFiles('src/Cargo.lock') }} + restore-keys: | + cargo-${{ runner.os }}- + + - name: Check formatting + run: cargo fmt --manifest-path src/Cargo.toml -- --check + + - name: Clippy lint + run: cargo clippy --manifest-path src/Cargo.toml -- -D warnings + + - name: Run tests + run: cargo test --manifest-path src/Cargo.toml + + - name: Install Tauri CLI + run: cargo install tauri-cli --locked + + - name: Build release + working-directory: src + run: cargo tauri build + + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: penpot-tauri-linux + path: | + src/target/release/bundle/deb/*.deb + src/target/release/bundle/rpm/*.rpm + src/target/release/bundle/appimage/*.AppImage diff --git a/.gitignore b/.gitignore index cff5caf..cda3c64 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.copilot/ node_modules/ package-lock.json out/ diff --git a/LICENSE b/LICENSE index 4248217..eb04a22 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,9 @@ MIT License -Copyright (c) 2022 vikdevelop +Copyright (c) 2026 Olivier Steck + +This project is a fork of vikdevelop/penpot-electron, licensed under the MIT +License. See LICENSE.vikdevelop for the original copyright notice. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/LICENSE.vikdevelop b/LICENSE.vikdevelop new file mode 100644 index 0000000..4248217 --- /dev/null +++ b/LICENSE.vikdevelop @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 vikdevelop + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 1fdd23e..423b59f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,33 @@ -# penpot-electron-app +# penpot-tauri + +> **Branched from [vikdevelop/penpot-electron](https://github.com/vikdevelop/penpot-electron)** — rewritten as a [Tauri](https://tauri.app) app. + +A [Tauri](https://tauri.app) wrapper for [Penpot](https://penpot.app) that targets a **local self-hosted instance** instead of the cloud service. + +![Screenshot](https://github.com/vikdevelop/penpot/blob/main/screnshots/penpot_home.png) + +## Source repositories + +| Component | Source | Branch/Path | +|-----------|--------|--------------| +| Tauri app (`src-tauri/`, `package.json`) | Branched from [vikdevelop/penpot-electron](https://github.com/vikdevelop/penpot-electron) | `main` | +| Docker Compose stack (`docker-compose.yml`) | [penpot/penpot](https://github.com/penpot/penpot) | `main` › `docker/images/docker-compose.yaml` | + +The `docker-compose.yml` in this repository carries its full upstream git history +(46 commits) imported from `penpot/penpot` via an orphan-branch merge, so +`git log -- docker-compose.yml` traces every change back to the source. + +## Prerequisites + +- `docker` +- [Rust](https://rustup.rs/) (stable toolchain) +- System dependencies for Tauri (on Debian/Ubuntu): + ```bash + sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file \ + libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev + ``` + +## Local instance quick-start An [Electron](https://www.electronjs.org/) wrapper for [Penpot](https://penpot.app) that targets a **local self-hosted instance** instead of the cloud service. @@ -41,10 +70,28 @@ PENPOT_URL=http://localhost:9002 bash start.sh For the original cloud-hosted build via Flatpak: ```bash -wget -qO /tmp/build.sh https://raw.githubusercontent.com/vikdevelop/penpot-electron/main/build.sh && sh /tmp/build.sh +# clone and run in one step +git clone git@github.com:oliben67/penpot-tauri.git +cd penpot-tauri +bash start.sh ``` -Dependencies: +The script will: +1. Start the full Penpot stack via `docker compose` +2. Wait for the frontend to be reachable on `localhost:9001` +3. Build and launch the Tauri window pointing at `http://localhost:9001` + +To use a different URL or port: ```bash -flatpak install -y org.electronjs.Electron2.BaseApp org.freedesktop.Sdk org.freedesktop.Sdk.Extension.node16 +PENPOT_URL=http://localhost:9002 bash start.sh +``` + +## Development + +```bash +# Run in dev mode (hot-reload for Rust changes) +PENPOT_URL=http://localhost:9001 cargo tauri dev + +# Build a release binary +cargo tauri build ``` diff --git a/build.sh b/build.sh index 045655a..a708dd2 100644 --- a/build.sh +++ b/build.sh @@ -1,14 +1,15 @@ #!/usr/bin/bash -echo -e '\033[1m Project: vikdevelop/penpot-electron \033[0m' +# Branched from vikdevelop/penpot-electron +echo -e '\033[1m Project: penpot-tauri \033[0m' echo "- Downloading Manifest" cd /tmp -wget -c https://raw.githubusercontent.com/vikdevelop/penpot-electron/main/manifest.yaml > /dev/null 2>&1 +wget -c https://raw.githubusercontent.com/oliben67/penpot-tauri/main/manifest.yaml > /dev/null 2>&1 mkdir flatpak -echo "- Building and installing penpot-electron with flatpak builder" +echo "- Building and installing penpot-tauri with flatpak builder" echo "--- it's gonna take a while" flatpak-builder flatpak manifest.yaml --install --user > /dev/null 2>&1 echo "- Cleaning build files" rm -rf /tmp/flatpak rm -rf /tmp/.flatpak-builder rm /tmp/manifest.yaml -echo -e '\033[1m Done! Penpot-electron was builded and installed successfull! \033[0m' +echo -e '\033[1m Done! penpot-tauri was built and installed successfully! \033[0m' diff --git a/flatpak/com.github.oliben67.penpot-tauri.desktop b/flatpak/com.github.oliben67.penpot-tauri.desktop new file mode 100644 index 0000000..d016a00 --- /dev/null +++ b/flatpak/com.github.oliben67.penpot-tauri.desktop @@ -0,0 +1,6 @@ +[Desktop Entry] +Name=Penpot +Icon=com.github.oliben67.penpot-tauri_i +Exec=penpot-tauri.sh +Categories=Internet +Type=Application diff --git a/flatpak/com.github.oliben67.penpot-tauri.metainfo.xml b/flatpak/com.github.oliben67.penpot-tauri.metainfo.xml new file mode 100644 index 0000000..36a294e --- /dev/null +++ b/flatpak/com.github.oliben67.penpot-tauri.metainfo.xml @@ -0,0 +1,50 @@ + + + com.github.oliben67.penpot-tauri + com.github.oliben67.penpot-tauri.desktop + Penpot + Open-source prototyping and design platform + CC0-1.0 + MIT + + +

Penpot is the first Open Source design and prototyping platform meant for cross-domain teams a works with open web standards (SVG). This is a gret alternative of Figma.

+

Features:

+ +

NOTE: This app is Electron wrapper of Penpot web app.

+ + + https://penpot.app + https://help.penpot.app/ + + + + https://raw.githubusercontent.com/oliben67/penpot-tauri/main/screnshots/penpot_home.png + + + https://raw.githubusercontent.com/oliben67/penpot-tauri/main/screnshots/penpot_login.png + + + + + + + Tools + + + + + + + diff --git a/flatpak/com.github.vikdevelop.penpot-electron.desktop b/flatpak/com.github.vikdevelop.penpot-electron.desktop index 29a26e3..d016a00 100644 --- a/flatpak/com.github.vikdevelop.penpot-electron.desktop +++ b/flatpak/com.github.vikdevelop.penpot-electron.desktop @@ -1,6 +1,6 @@ [Desktop Entry] Name=Penpot -Icon=com.github.vikdevelop.penpot-electron_i -Exec=penpot-electron.sh +Icon=com.github.oliben67.penpot-tauri_i +Exec=penpot-tauri.sh Categories=Internet Type=Application diff --git a/flatpak/com.github.vikdevelop.penpot-electron.metainfo.xml b/flatpak/com.github.vikdevelop.penpot-electron.metainfo.xml index aafa62e..616a5a7 100644 --- a/flatpak/com.github.vikdevelop.penpot-electron.metainfo.xml +++ b/flatpak/com.github.vikdevelop.penpot-electron.metainfo.xml @@ -1,7 +1,7 @@ - com.github.vikdevelop.penpot-electron - com.github.vikdevelop.penpot-electron.desktop + com.github.vikdevelop.penpot-tauri + com.github.vikdevelop.penpot-tauri.desktop Penpot Open-source prototyping and design platform CC0-1.0 @@ -30,10 +30,10 @@ - https://raw.githubusercontent.com/vikdevelop/penpot-electron/main/screnshots/penpot_home.png + https://raw.githubusercontent.com/oliben67/penpot-tauri/main/screnshots/penpot_home.png - https://raw.githubusercontent.com/vikdevelop/penpot-electron/main/screnshots/penpot_login.png + https://raw.githubusercontent.com/oliben67/penpot-tauri/main/screnshots/penpot_login.png diff --git a/flatpak/icons/com.github.vikdevelop.penpot-electron.png b/flatpak/icons/com.github.oliben67.penpot-tauri.png similarity index 100% rename from flatpak/icons/com.github.vikdevelop.penpot-electron.png rename to flatpak/icons/com.github.oliben67.penpot-tauri.png diff --git a/flatpak/icons/com.github.vikdevelop.penpot-electron_i.png b/flatpak/icons/com.github.oliben67.penpot-tauri_i.png similarity index 100% rename from flatpak/icons/com.github.vikdevelop.penpot-electron_i.png rename to flatpak/icons/com.github.oliben67.penpot-tauri_i.png diff --git a/manifest.yaml b/manifest.yaml index 99ece3a..eb794f1 100644 --- a/manifest.yaml +++ b/manifest.yaml @@ -1,10 +1,10 @@ -app-id: com.github.vikdevelop.penpot-electron +app-id: com.github.oliben67.penpot-tauri runtime: org.freedesktop.Platform runtime-version: '21.08' sdk: org.freedesktop.Sdk base: org.electronjs.Electron2.BaseApp base-version: "21.08" -command: penpot-electron.sh +command: penpot-tauri.sh sdk-extensions: - org.freedesktop.Sdk.Extension.node16 finish-args: @@ -22,7 +22,7 @@ modules: buildsystem: simple build-options: env: - XDG_CACHE_HOME: /run/build/penpot-electron/flatpak-node/cache + XDG_CACHE_HOME: /run/build/penpot-tauri/flatpak-node/cache build-args: - --share=network build-commands: @@ -31,15 +31,15 @@ modules: - yarn electron-packager ./ penpot --platform=linux --arch=x64 --electron-version=15.4.1 --out=penpot/ - mkdir /app/main - cp -R penpot/penpot-linux-x64/* /app/main - - install -D -t /app/bin penpot-electron.sh - - install -D -t /app/share/applications flatpak/com.github.vikdevelop.penpot-electron.desktop - - install -D -t /app/share/metainfo flatpak/com.github.vikdevelop.penpot-electron.metainfo.xml - - install -D -t /app/share/icons/hicolor/128x128/apps flatpak/icons/com.github.vikdevelop.penpot-electron_i.png + - install -D -t /app/bin penpot-tauri.sh + - install -D -t /app/share/applications flatpak/com.github.oliben67.penpot-tauri.desktop + - install -D -t /app/share/metainfo flatpak/com.github.oliben67.penpot-tauri.metainfo.xml + - install -D -t /app/share/icons/hicolor/128x128/apps flatpak/icons/com.github.oliben67.penpot-tauri_i.png sources: - type: archive - url: https://github.com/vikdevelop/penpot-electron/archive/refs/tags/0.2.3.tar.gz + url: https://github.com/oliben67/penpot-tauri/archive/refs/tags/0.2.3.tar.gz sha256: d7f03976aaf84ae92683ed98e48eb05dbe1787f5bfd35241f302db52973096a2 - type: script - dest-filename: penpot-electron.sh + dest-filename: penpot-tauri.sh commands: - zypak-wrapper.sh /app/main/penpot "$@" diff --git a/src/src/main.rs b/src/src/main.rs new file mode 100644 index 0000000..94ad1ba --- /dev/null +++ b/src/src/main.rs @@ -0,0 +1,84 @@ +// Prevents additional console window on Windows in release, DO NOT REMOVE!! +#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] + +use tauri::Manager; + +const DEFAULT_PENPOT_URL: &str = "http://localhost:9001"; + +/// Resolve the Penpot URL from the environment, falling back to the default. +fn resolve_penpot_url() -> String { + std::env::var("PENPOT_URL").unwrap_or_else(|_| DEFAULT_PENPOT_URL.to_string()) +} + +/// Validate that a URL string can be parsed into a valid URL. +#[cfg(test)] +fn validate_url(url: &str) -> Result { + url.parse::() +} + +fn main() { + let penpot_url = resolve_penpot_url(); + + tauri::Builder::default() + .setup(move |app| { + let window = app + .get_webview_window("main") + .expect("failed to get main window"); + + let _ = window.navigate(penpot_url.parse().expect("invalid PENPOT_URL")); + + Ok(()) + }) + .run(tauri::generate_context!()) + .expect("error while running tauri application"); +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn default_url_when_env_unset() { + // Make sure PENPOT_URL is not set for this test + std::env::remove_var("PENPOT_URL"); + assert_eq!(resolve_penpot_url(), DEFAULT_PENPOT_URL); + } + + #[test] + fn custom_url_from_env() { + let custom = "http://my-penpot:8080"; + std::env::set_var("PENPOT_URL", custom); + assert_eq!(resolve_penpot_url(), custom); + std::env::remove_var("PENPOT_URL"); + } + + #[test] + fn default_url_is_valid() { + assert!(validate_url(DEFAULT_PENPOT_URL).is_ok()); + } + + #[test] + fn valid_http_url() { + assert!(validate_url("http://localhost:9001").is_ok()); + } + + #[test] + fn valid_https_url() { + assert!(validate_url("https://penpot.example.com").is_ok()); + } + + #[test] + fn invalid_url_rejected() { + assert!(validate_url("not a url").is_err()); + } + + #[test] + fn empty_url_rejected() { + assert!(validate_url("").is_err()); + } + + #[test] + fn url_with_path_is_valid() { + assert!(validate_url("http://localhost:9001/some/path").is_ok()); + } +}