mirror of https://github.com/Stirling-Tools/Stirling-PDF.git synced 2026-09-03 05:10:16 +03:00

Files

T

EthanHealy01 436afa51d7 Always use the modern logo in the SaaS build (#6775 )

## What

Make the **SaaS** build always use the modern logo, so the classic logo
can no longer appear anywhere in the SaaS app.

This is a minimal, SaaS-only alternative to the full classic-logo
removal PR (~80 files). **OSS (`core`) and proprietary builds are
untouched** — they keep the full modern/classic variant system,
including the admin _Logo Style_ picker.

## How

A single SaaS-layer override shadows the core hook:

- `frontend/editor/src/saas/hooks/useLogoVariant.ts` → returns
`"modern"` unconditionally.

In the SaaS build the `@app/*` alias cascade resolves
`@app/hooks/useLogoVariant` to `src/saas/*` before `src/core/*`, so this
shadows the core implementation (which otherwise resolves the variant
from the stored user preference or the server `logoStyle`).

## Why one file is enough

All logo rendering funnels through `useLogoVariant()`:

- `useLogoAssets()` → favicon, web manifest, apple-touch icon, wordmark,
`logo512`, tooltip logo — consumed by `BrandingAssetManager` (which sets
`<link rel="icon|manifest|apple-touch-icon">`), `Wordmark`, `LogoIcon`,
`Tooltip`.
- `useLogoPath()` → the no-text logo SVGs.
- The login-carousel slides (`buildLoginSlides`) receive the variant
from `AuthLayout`, which calls the hook.

Everything else that references a logo in SaaS already hardcodes
`modern-logo` (`index.html`, the SaaS
`Login`/`Signup`/`AuthCallback`/`OAuthConsent` routes, cloud onboarding,
account/MFA QR logos).

The only hardcoded `classic-logo` reference — the admin _Logo Style_
picker in `AdminGeneralSection` — is **not shipped in SaaS**:
`createSaasConfigNavSections` builds from the core nav sections and
never includes the proprietary admin sections.

`manifest-classic.json` and the classic assets remain in the shared
`public/` folder (served by all builds) but are never referenced in the
SaaS bundle.

## Test plan

- [x] `task frontend:typecheck:saas` — clean
- [x] `eslint` on the new file — clean

2026-06-23 13:03:17 +00:00

.claude/agents

playwright (#6025 )

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

.storybook

Revert "SaaS fixes (#6578 )"

2026-06-16 16:48:30 +01:00

editor

Always use the modern logo in the SaaS build (#6775 )

2026-06-23 13:03:17 +00:00

portal

Upgrade to TypeScript 6 (#6772 )

2026-06-23 08:52:32 +00:00

scripts

Unified auth for portal and editor (#6725 )

2026-06-22 16:22:36 +00:00

shared

Upgrade to TypeScript 6 (#6772 )

2026-06-23 08:52:32 +00:00

.gitignore

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

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

.prettierignore

add prerendered Open Graph previews and OG card generator (#6661 )

2026-06-18 13:49:16 +00:00

.prettierrc

Prettier 2: Electric Boogaloo (#6113 )

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

eslint.config.mjs

I18n on portal (#6761 )

2026-06-22 12:57:12 +00:00

package-lock.json

Upgrade to TypeScript 6 (#6772 )

2026-06-23 08:52:32 +00:00

package.json

Upgrade to TypeScript 6 (#6772 )

2026-06-23 08:52:32 +00: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.