Merge pull request #107 from elek-io/change-name-to-desktop

Rename package from Client to Desktop

Author: Nils-Kolvenbach

AGENTS.md

@@ -1,23 +1,23 @@
 # AGENTS.md
 
-Guidance for AI agents and contributors working on `@elek-io/client`.
+Guidance for AI agents and contributors working on `@elek-io/desktop`.
 
 `@elek-io/core` handles file IO and git version control for elek.io Projects, a headless, git-backed CMS. It is published as a TypeScript library with Node, Browser, Astro and CLI entry points.
 
-`@elek-io/client` uses `@elek-io/core` and provides a UI on top of that business logic, packaged with Electron as a cross-platform desktop application.
+`@elek-io/desktop` uses `@elek-io/core` and provides a UI on top of that business logic, packaged with Electron as a cross-platform desktop application.
 
 ## Documentation
 
 Documentation is split by what you are working on:
 
-- [`contributing/`](./contributing/) - contributor and design docs for the client: the Electron process architecture, the IPC security model, TanStack Query data loading, and the dynamic form system. Start at [`contributing/README.md`](./contributing/README.md). The client ships as a packaged desktop app, not an npm package, so these docs are never shipped and may link anywhere.
-- **Core's behavior** is documented inside the `@elek-io/core` package itself. After `pnpm install`, read it under [`node_modules/@elek-io/core/docs/`](./node_modules/@elek-io/core/docs/index.md) (content export, the local API, API client generation, fields, storage layout, and more). This is the reference for anything the client delegates to Core.
+- [`contributing/`](./contributing/) - contributor and design docs for the desktop app: the Electron process architecture, the IPC security model, TanStack Query data loading, and the dynamic form system. Start at [`contributing/README.md`](./contributing/README.md). The desktop app ships packaged, not as an npm package, so these docs are never shipped and may link anywhere.
+- **Core's behavior** is documented inside the `@elek-io/core` package itself. After `pnpm install`, read it under [`node_modules/@elek-io/core/docs/`](./node_modules/@elek-io/core/docs/index.md) (content export, the local API, API client generation, fields, storage layout, and more). This is the reference for anything the desktop app delegates to Core.
 - To **contribute to Core** itself, use the [`@elek-io/core` repository](https://github.com/elek-io/core). Core's own contributor docs are not part of its published package, so they live only there.
 
 Two rules follow:
 
-- **Read before you change.** Before working on an area, read its doc first so you change behavior on purpose, not by guesswork. For client behavior that is the matching doc in `contributing/`; for behavior that comes from Core, read Core's docs in the package.
-- **Write after you change.** When you change client behavior a user or contributor should know about, update the matching doc in `contributing/` in the same change. Changes to Core itself do not belong in this repo - make them in the separate [`@elek-io/core`](https://github.com/elek-io/core) repository and document them there.
+- **Read before you change.** Before working on an area, read its doc first so you change behavior on purpose, not by guesswork. For desktop app behavior that is the matching doc in `contributing/`; for behavior that comes from Core, read Core's docs in the package.
+- **Write after you change.** When you change desktop app behavior a user or contributor should know about, update the matching doc in `contributing/` in the same change. Changes to Core itself do not belong in this repo - make them in the separate [`@elek-io/core`](https://github.com/elek-io/core) repository and document them there.
 
 ## Commands
 

CHANGELOG.md

@@ -1,4 +1,4 @@
-# @elek-io/client
+# @elek-io/desktop
 
 ## 0.3.4
 

README.md

@@ -1,17 +1,17 @@
-# elek.io Client
+# elek.io Desktop
 
 > A modern, offline-first content management system (CMS) and digital asset manager (DAM).
 
-[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey.svg)](https://github.com/elek-io/client)
+[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey.svg)](https://github.com/elek-io/desktop)
 
 > [!IMPORTANT]  
-> elek.io Client is under active development and not yet ready for production usage! Feel free to check it out and make suggestions.
+> elek.io Desktop is under active development and not yet ready for production usage! Feel free to check it out and make suggestions.
 
 ### Motivation
 
 Traditional CMS solutions like WordPress need to be installed on a server, leading to costs for hosting it 24/7, security vulnerabilities by exposing the server to the internet, and the need to maintain / keep the server, database and CMS up to date.
 
-elek.io Client solves these problems by being an offline-first desktop application that works entirely on your local machine, with optional remote synchronization.
+elek.io Desktop solves these problems by being an offline-first desktop application that works entirely on your local machine, with optional remote synchronization.
 
 ### What Makes It Special
 
@@ -27,22 +27,15 @@ elek.io Client solves these problems by being an offline-first desktop applicati
 
 ### Download
 
-Download the latest version for your platform:
+Download the latest release for your platform:
 
-- **Windows**: [Download installer](https://github.com/elek-io/client/releases)
-- **macOS**: [Download DMG](https://github.com/elek-io/client/releases)
-- **Linux**: Download [AppImage](https://github.com/elek-io/client/releases) / [Snap](https://github.com/elek-io/client/releases) / [DEB](https://github.com/elek-io/client/releases)
+- **Windows**: [Installer](https://github.com/elek-io/desktop/releases/latest/download/elek-io-desktop-setup.exe)
+- **macOS (Apple Silicon)**: [DMG](https://github.com/elek-io/desktop/releases/latest/download/elek-io-desktop-arm64.dmg)
+- **macOS (Intel)**: [DMG](https://github.com/elek-io/desktop/releases/latest/download/elek-io-desktop-x64.dmg)
+- **Linux**: [AppImage](https://github.com/elek-io/desktop/releases/latest/download/elek-io-desktop.AppImage) · [DEB](https://github.com/elek-io/desktop/releases/latest/download/elek-io-desktop.deb) · [RPM](https://github.com/elek-io/desktop/releases/latest/download/elek-io-desktop.rpm) · [pacman](https://github.com/elek-io/desktop/releases/latest/download/elek-io-desktop.pacman)
 
-### System Requirements
-
-Although elek.io Client might run on older hard and software than listed below, the following is the recommended minimum:
-
-- **Windows**: Windows 10 or later
-- **macOS**: macOS 13.7.6 (Ventura) or later
-- **Linux**: Ubuntu 22.04.5, or equivalent
-- **RAM**: 4 GB minimum, 8 GB recommended
-- **Disk Space**: 500 MB for elek.io Client + space for your Projects
+Each link resolves to the newest published release. For older versions and checksums, see the [releases page](https://github.com/elek-io/desktop/releases).
 
 ## For Developers
 
-For insight on how elek.io Client works, please refer to the [contributing folder](contributing/README.md).
+For insight on how elek.io Desktop works, please refer to the [contributing folder](contributing/README.md).

contributing/README.md

@@ -1,9 +1,9 @@
 # Developer Documentation
 
-Welcome to the elek.io Client developer documentation. This guide will help you understand the codebase architecture and development patterns.
+Welcome to the elek.io Desktop developer documentation. This guide will help you understand the codebase architecture and development patterns.
 
 > [!NOTE]
-> This folder documents how to **contribute to** elek.io Client. If instead you want to consume your Projects' content inside your own applications, see the [@elek-io/core documentation](https://github.com/elek-io/core). Core ships its full guides (content export, local API, API client generation) both in its repository and in the package's `docs` folder.
+> This folder documents how to **contribute to** elek.io Desktop. If instead you want to consume your Projects' content inside your own applications, see the [@elek-io/core documentation](https://github.com/elek-io/core). Core ships its full guides (content export, local API, API client generation) both in its repository and in the package's `docs` folder.
 
 ## Prerequisites
 
@@ -29,7 +29,7 @@ Then proceed to the specific topics based on your interests or contribution goal
 - **[E2E Testing](./testing.md)** - Playwright tests against the packaged app, fixtures, isolation, and CI
 - **[Releasing](./releasing.md)** - versioning with changesets and how CD publishes draft GitHub Releases
 
-For a running list of things Core supports but the client cannot use yet, see **[Not Yet Implemented](./not-yet-implemented.md)**. Add to it whenever you find such a gap.
+For a running list of things Core supports but the desktop app cannot use yet, see **[Not Yet Implemented](./not-yet-implemented.md)**. Add to it whenever you find such a gap.
 
 ## Contributing
 

contributing/overview.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-elek.io Client is built on [Electron](https://www.electronjs.org/) to create a cross-platform desktop application with web technologies (TypeScript, React).
+elek.io Desktop is built on [Electron](https://www.electronjs.org/) to create a cross-platform desktop application with web technologies (TypeScript, React).
 
 > [!NOTE]
 > By choosing Electron, we keep the languages (everything is mainly TypeScript) used throughout our repositories to a minimum and the knowledge barrier for potential contributors low. Although applications build e.g. with [Tauri](https://tauri.app/) do have a smaller bundle size and memory footprint, adding another language (Rust) would increase complexity for contributors by alot.
@@ -31,7 +31,7 @@ Electron applications consist of three main layers: the Main Process, the Preloa
 
 ```
 
-While elek.io Client provides the user interface in a desktop application, all core functionalities related to file I/O, content handling, Git operations, local read-only API hosting and CLI usage are encapsulated in the separate [@elek-io/core](https://github.com/elek-io/core) library.
+While elek.io Desktop provides the user interface in a desktop application, all core functionalities related to file I/O, content handling, Git operations, local read-only API hosting and CLI usage are encapsulated in the separate [@elek-io/core](https://github.com/elek-io/core) library.
 
 @elek-io/core is used by the Main Process, since only it has access to the filesystem and Node.js APIs - the Renderer Process is sandboxed for security reasons.
 
@@ -169,7 +169,7 @@ When adding a new global provider, decide which level it belongs to. Anything th
 
 ### Security
 
-Handling user content that is distributed and could potentially be malicious within an app that has access to the file system, strict security is necessary. elek.io Client follows [Electron's security best practices](https://www.electronjs.org/docs/latest/tutorial/security) to create strong isolation boundaries.
+Handling user content that is distributed and could potentially be malicious within an app that has access to the file system, strict security is necessary. elek.io Desktop follows [Electron's security best practices](https://www.electronjs.org/docs/latest/tutorial/security) to create strong isolation boundaries.
 
 The Renderer Process can only communicate with the Main Process via a controlled IPC API exposed through the Preload Script. This ensures that untrusted code running in the Renderer Process (e.g., third-party libraries or user content) cannot directly access Node.js APIs or the filesystem.
 
@@ -191,7 +191,7 @@ A Content Security Policy is enforced via a `<meta>` tag in the `src/renderer/in
 
 #### External Content Restrictions
 
-Some links to elek.io domains and loading of content are allowed in elek.io Client. To prevent abuse and potential security risks, the following restrictions are in place:
+Some links to elek.io domains and loading of content are allowed in elek.io Desktop. To prevent abuse and potential security risks, the following restrictions are in place:
 
 **URL Whitelisting**:
 
@@ -205,7 +205,7 @@ All external requests (e.g., when a user clicks a link inside the renderer or an
 
 See `allowedHostnamesToLoadExternal` in [`src/main/index.ts:41-47`](/src/main/index.ts) for the implementation.
 
-Links to whitelisted external hostnames are opened in the default system browser, not within an elek.io Client renderer window.
+Links to whitelisted external hostnames are opened in the default system browser, not within an elek.io Desktop renderer window.
 
 A separate whitelist, `allowedHostnamesToLoadInternal`, controls in-window navigation: a `will-navigate` handler blocks any navigation whose origin is not on it. This list is empty in production and only holds the Vite dev server URL in development, so navigating the renderer window away from the app is effectively disabled in production. Note the external list is matched against the URL's `hostname`, while the internal list is matched against its `origin`.
 

contributing/renderer/loading-and-updating-data.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-elek.io Client uses [TanStack Query](https://tanstack.com/query/latest) (formerly React Query) for all data fetching and mutations. This provides a consistent, type-safe way to interact with the main process via IPC, with built-in caching, loading states, and error handling.
+elek.io Desktop uses [TanStack Query](https://tanstack.com/query/latest) (formerly React Query) for all data fetching and mutations. This provides a consistent, type-safe way to interact with the main process via IPC, with built-in caching, loading states, and error handling.
 
 ## Configuration
 
@@ -463,7 +463,7 @@ Mutations already have `onSuccess` handlers that update the necessary caches. Us
 
 ## Error Handling
 
-The client handles errors in three layers:
+The desktop app handles errors in three layers:
 
 1. **Route error boundaries** - the root `ErrorComponent` in [`routes/__root.tsx`](../../src/renderer/routes/__root.tsx) catches all unhandled errors, logs them to the Core logger, and shows a friendly error page with a way back to the projects list. Sentry capture for React errors is wired separately, via Sentry's `reactErrorHandler` passed to `ReactDOM.createRoot` in [`app.tsx`](../../src/renderer/app.tsx) (Sentry itself is initialized in [`index.ts`](../../src/renderer/index.ts)).
 2. **Query and mutation errors** - `throwOnError: true` is set by default (via `useQueryNoError` and `customMutationOptions`), so query errors bubble to the nearest error boundary and mutation failures additionally show a toast through the global handler.

contributing/renderer/routing.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-elek.io Client uses [TanStack Router](https://tanstack.com/router/latest) with file-based routing. Routes live in [`src/renderer/routes/`](../../src/renderer/routes/) and the route tree is auto-generated into `routeTree.gen.ts` by the TanStack Router plugin (configured in `electron.vite.config.ts`) - never edit that file by hand.
+elek.io Desktop uses [TanStack Router](https://tanstack.com/router/latest) with file-based routing. Routes live in [`src/renderer/routes/`](../../src/renderer/routes/) and the route tree is auto-generated into `routeTree.gen.ts` by the TanStack Router plugin (configured in `electron.vite.config.ts`) - never edit that file by hand.
 
 **Key settings:**
 

electron-builder.yml

@@ -1,5 +1,5 @@
-appId: io.elek.client
-productName: 'elek.io Client'
+appId: io.elek.desktop
+productName: 'elek.io Desktop'
 directories:
   buildResources: build
 files:
@@ -18,19 +18,22 @@ files:
   - '!{AGENTS.md,CLAUDE.md,components.json,eslint.config.mjs,.node-version}'
   - '!{playwright.config.ts,pnpm-workspace.yaml,.prettierrc.json}'
 extraMetadata:
-  name: 'elek-io-client' # Overwrites package.json name, since it cannot handle special characters
+  name: 'elek-io-desktop' # Overwrites package.json name, since it cannot handle special characters
 asarUnpack:
   - resources/**
 win:
-  executableName: 'elek.io Client'
+  executableName: 'elek.io Desktop'
 nsis:
-  artifactName: elek-io-client-${version}-setup.${ext}
+  # No version in the name so github.com/.../releases/latest/download/<file> stays
+  # a stable link. Trade-off: Windows differential updates fall back to a full
+  # download, since electron-updater derives the old blockmap URL by version.
+  artifactName: elek-io-desktop-setup.${ext}
   shortcutName: ${productName}
   uninstallDisplayName: ${productName}
   createDesktopShortcut: always
 mac:
   # Include the arch so Intel and ARM artifacts do not overwrite each other in the shared release
-  artifactName: elek-io-client-${version}-${arch}.${ext}
+  artifactName: elek-io-desktop-${arch}.${ext}
   entitlementsInherit: build/entitlements.mac.plist
   extendInfo:
     - NSCameraUsageDescription: Application requests access to the device's camera.
@@ -48,7 +51,7 @@ mac:
     releaseType: draft
     channel: latest-${arch}
 dmg:
-  artifactName: elek-io-client-${version}-${arch}.${ext}
+  artifactName: elek-io-desktop-${arch}.${ext}
 linux:
   # All four targets are auto-updatable via electron-updater (AppImage, deb,
   # rpm, pacman), so each one keeps in-app updates working. snap is
@@ -60,8 +63,16 @@ linux:
     - rpm
     - pacman
   category: Office
+# Linux builds are x64 only (see the CI matrix), so version-less and arch-less
+# names are unambiguous and keep the latest-download links stable.
 appImage:
-  artifactName: elek-io-client-${version}.${ext}
+  artifactName: elek-io-desktop.${ext}
+deb:
+  artifactName: elek-io-desktop.${ext}
+rpm:
+  artifactName: elek-io-desktop.${ext}
+pacman:
+  artifactName: elek-io-desktop.${ext}
 npmRebuild: false
 # The CD workflow pre-creates one draft GitHub Release per version. Each runner
 # uploads its installers and update metadata into that shared draft, which

electron.vite.config.ts

@@ -12,7 +12,7 @@ export default defineConfig({
     plugins: [
       sentryVitePlugin({
         org: 'elek-io',
-        project: 'client',
+        project: 'desktop',
       }),
     ],
   },

package.json

@@ -1,14 +1,14 @@
 {
-  "name": "@elek-io/client",
-  "productName": "elek.io Client",
-  "description": "The elek.io Client is a desktop application for Windows, macOS and Linux that allows you to manage content.",
+  "name": "@elek-io/desktop",
+  "productName": "elek.io Desktop",
+  "description": "The elek.io Desktop is a desktop application for Windows, macOS and Linux that allows you to manage content.",
   "version": "0.3.4",
   "type": "module",
   "main": "./out/main/index.js",
   "homepage": "https://elek.io",
-  "repository": "https://github.com/elek-io/client",
+  "repository": "https://github.com/elek-io/desktop",
   "bugs": {
-    "url": "https://github.com/elek-io/client/issues"
+    "url": "https://github.com/elek-io/desktop/issues"
   },
   "author": {
     "name": "elek.io",