mirror of https://github.com/arsvendg/Stirling-PDF.git synced 2026-07-14 10:34:06 +02:00

Files

T

James BruntonandGitHub e0fc5061de Delete dead translations (#6581 )

# Description of Changes
Adds all the missing translations that I could find (they're all dynamic
ones that the existing test can't detect are required) and adds a new
test to find as many unused translations as possible. The test has an
ignore list for translations that are used, but dynamically so the test
can't find them (most of the settings UI translations are built up
dynamically like that).

This PR is scoped to just include en-GB translation changes, since
that's the main supported language. We'll need to do a translation PR to
trim all the dead keys from the other languages, and add the missing
ones.

2026-06-10 09:49:00 +00:00

.claude/agents

playwright (#6025 )

2026-04-27 11:35:50 +01:00

.storybook

Portal (#6391 )

2026-06-02 16:08:24 +00:00

editor

Delete dead translations (#6581 )

2026-06-10 09:49:00 +00:00

portal

Fix mockServiceWorker.js reformatting (#6526 )

2026-06-03 15:47:03 +00:00

scripts

Fix desktop updater latest.json generation for releases (#6540 )

2026-06-05 15:41:41 +01:00

shared

Portal (#6391 )

2026-06-02 16:08:24 +00:00

.gitignore

UI changes to update and support auto updating (#6075 )

2026-06-02 23:11:37 +01:00

.prettierignore

UI changes to update and support auto updating (#6075 )

2026-06-02 23:11:37 +01:00

.prettierrc

Prettier 2: Electric Boogaloo (#6113 )

2026-04-17 09:50:16 +00:00

eslint.config.mjs

Make any typing linting opt-out instead of opt-in (#6542 )

2026-06-05 14:11:26 +00:00

package-lock.json

perf(compression): add vite-plugin-compression for gzip and Brotli support (#6279 )

2026-06-05 18:49:09 +01:00

package.json

perf(compression): add vite-plugin-compression for gzip and Brotli support (#6279 )

2026-06-05 18:49:09 +01:00

README.md

Restructure/frontend editor (#6404 )

2026-05-22 13:40:34 +01:00

README.md

Frontend

All frontend commands are run from the repository root using Task:

task frontend:dev — start Vite dev server (localhost:5173)
task frontend:build — production build
task frontend:test — run tests
task frontend:test:watch — run tests in watch mode
task frontend:lint — run ESLint + cycle detection
task frontend:typecheck — run TypeScript type checking
task frontend:check — run typecheck + lint + test
task frontend:install — install npm dependencies

For desktop app development, see the Tauri section below.

Layout

frontend/ is a workspace containing one or more apps. Today it holds the PDF editor under frontend/editor/; new apps (the developer portal, etc.) will sit alongside it as siblings. Shared tooling — package.json, node_modules, .storybook/, ESLint, Prettier — lives at frontend/ so every app installs once and lints with the same config.

Environment Variables

The editor's environment variables live in committed .env files at frontend/editor/:

.env — used by all builds (core, proprietary, and as the base for desktop/SaaS)
.env.desktop — additional vars loaded in desktop (Tauri) mode
.env.saas — additional vars loaded in SaaS mode

These files contain non-secret defaults and are checked into Git, so most dev work needs no further setup.

To override values locally (API keys, machine-specific settings), create an uncommitted sibling editor/.env.local / editor/.env.desktop.local / editor/.env.saas.local. Vite automatically layers these on top of the committed files.

Docker Setup

For Docker deployments and configuration, see the Docker README.

Tauri

All desktop tasks are available via Task. From the root of the repo:

Dev

task desktop:dev

This ensures the JLink runtime and backend JAR exist (skipping if already built), then starts Tauri in dev mode.

Build

task desktop:build

This does a full clean rebuild of the backend JAR and JLink runtime, then builds the Tauri app for production.

Platform-specific dev builds are also available:

task desktop:build:dev           # No bundling
task desktop:build:dev:mac       # macOS .app bundle
task desktop:build:dev:windows   # Windows NSIS installer
task desktop:build:dev:linux     # Linux AppImage

JLink Tasks

You can also run JLink steps individually:

task desktop:jlink          # Build JAR + create JLink runtime
task desktop:jlink:jar      # Build backend JAR only
task desktop:jlink:runtime  # Create JLink custom JRE only
task desktop:jlink:clean    # Remove JLink artifacts

Clean

task desktop:clean

Removes all desktop build artifacts including JLink runtime, bundled JARs, Cargo build, and dist/build directories.