Skip to content

Commit 9f166aa

Browse files
committed
feat(docs): 📚 Add comprehensive API reference and architecture overview
feat(docs): 🔄 Introduce backup & portability strategies for data safety chore(docs): 📝 Document changelog highlights for version tracking feat(docs): ☁️ Outline Cloudflare Pages deployment process docs: 🤝 Create contributing guidelines for community involvement docs: 🔑 Define core concepts and data model for better understanding docs: 🗂️ Elaborate on developer guide for local development workflow feat(docs): 🐳 Provide Docker deployment instructions for production feat(docs): 💻 Detail Electron desktop app setup and usage docs: 🚀 Create getting started guide for new users docs: 🏃‍♂️ Explain different runtime modes for ByteBox feat(docs): 🎨 Describe theming and appearance customization options docs: 🛠️ Compile troubleshooting tips for common issues style: 🎨 Add custom styles for ByteBox documentation chore: 🔧 Add TypeScript configuration for better development experience chore: 🌐 Configure Wrangler for Cloudflare Pages deployment
1 parent c634ee2 commit 9f166aa

3 files changed

Lines changed: 17 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
### 🐳 Docker Deploy & 🖥️ Electron Desktop App
1313

14-
This release adds two new ways to run ByteBox: a Docker container for zero-setup server deployment, and a native Electron desktop app that packages ByteBox as a proper installed application (AppImage, .deb, .exe).
14+
This release adds two new ways to run ByteBox: a Docker container for zero-setup server deployment, and a native Electron desktop app that packages ByteBox as a proper installed application (AppImage, .deb).
1515

1616
#### Added
1717

18+
- **Linux desktop downloads** — Pre-built AppImage and .deb installers now available for direct download from the [ByteBox website](https://bytebox.pro/electron-desktop/), hosted on Cloudflare R2.
1819
- **Docker support** — Full containerised deployment via `docker compose up --build -d`. A two-stage Dockerfile (builder + slim runtime) compiles the app and bundles only what's needed. Data persists in a named Docker volume (`bytebox-data`) that survives restarts and image rebuilds.
1920
- **`docker-compose.yml`** — One-command orchestration with healthcheck, restart policy, and documented backup/restore commands.
2021
- **`docker-entrypoint.sh`** — Container entrypoint that runs `prisma migrate deploy` (idempotent) then starts Next.js — migrations are applied automatically on every boot.
2122
- **`.dockerignore`** — Keeps build context lean by excluding `node_modules`, `.next`, local databases, and Electron artifacts.
2223
- **Electron desktop app**`npm run electron:dev` launches ByteBox as a native desktop window. The main process starts the Next.js server in-process, applies SQLite migrations directly (no Prisma CLI needed), and stores the database in the OS user-data directory.
2324
- **`electron/main.ts`** — Electron main process with in-process Next.js server, migration runner (pure `better-sqlite3`, no CLI), secure `BrowserWindow` config, and external-link routing to the system browser.
2425
- **`electron/preload.ts`** — Minimal secure preload exposing only `window.electronAPI.isElectron` and `platform``contextIsolation: true`, `nodeIntegration: false`.
25-
- **`electron-builder.yml`** — Build config targeting **AppImage** + **.deb** (Linux) and **NSIS .exe** (Windows), with macOS .dmg support when building on macOS.
26+
- **`electron-builder.yml`** — Build config targeting **AppImage** + **.deb** (Linux).
2627
- **`public/icon.png` as app icon** — Set as the BrowserWindow icon so ByteBox appears with its own icon in the taskbar and titlebar.
27-
- **New npm scripts**: `electron:compile`, `electron:dev`, `electron:build`, `electron:build:linux`, `electron:build:win`, `electron:build:mac`.
28+
- **New npm scripts**: `electron:compile`, `electron:dev`, `electron:build`, `electron:build:linux`.
2829
- **New devDependencies**: `electron`, `electron-builder`, `esbuild`, `concurrently`, `wait-on`.
2930

3031
#### Changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,18 +110,26 @@ docker compose logs -f # follow logs
110110

111111
### 🖥️ **Desktop App (Electron)**
112112

113-
Runs ByteBox as a native installed application.
113+
Runs ByteBox as a native installed application. Currently available for **Linux**.
114+
115+
**Download pre-built installers from the [ByteBox website](https://bytebox.pro/electron-desktop/):**
116+
117+
| Format | Link |
118+
| --------------------- | ------------------------------------------------------------------------------------------------------ |
119+
| AppImage (any distro) | [ByteBox-2.4.0.AppImage](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/ByteBox-2.4.0.AppImage) |
120+
| .deb (Debian/Ubuntu) | [bytebox_2.4.0_amd64.deb](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/bytebox_2.4.0_amd64.deb) |
121+
122+
Or build from source:
114123

115124
```bash
116125
# Dev mode (hot-reload)
117126
npm run electron:dev
118127

119-
# Build installers
128+
# Build installer (Linux)
120129
npm run electron:build:linux # → release/*.AppImage + *.deb
121-
npm run electron:build:win # → release/*-Setup.exe
122130
```
123131

124-
The database is stored in the OS user-data directory (`~/.config/ByteBox/` on Linux, `%APPDATA%\ByteBox\` on Windows) and survives app updates.
132+
The database is stored in the OS user-data directory (`~/.config/ByteBox/` on Linux) and survives app updates.
125133

126134
---
127135

former-field-backup

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Subproject commit 2813cdcb68d42de26abcfdc2bd3a4c7bdeecd5c0

0 commit comments

Comments
 (0)