Skip to content

Commit 02ce54d

Browse files
committed
chore: update documentation for ByteBox v2.5.1 release
- Removed outdated AGENTS.md file. - Consolidated general rules and branding information into copilot-instructions.md. - Updated CHANGELOG.md with new downloads section for v2.5.1. - Revised OVERVIEW.md to reflect the latest version and last updated date. - Enhanced README.md with installation instructions for desktop app and Docker. - Improved website documentation for getting started, running ByteBox, and installation options.
1 parent 9bb52d1 commit 02ce54d

11 files changed

Lines changed: 430 additions & 367 deletions

File tree

.codex/AGENTS.md

Lines changed: 198 additions & 58 deletions
Large diffs are not rendered by default.

.github/AGENTS.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

.github/copilot-instructions.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# ByteBox - Development Guidelines
22

3+
## General Rules
4+
5+
- Always sound friendly and engaged with this project.
6+
- Use all available agents, skills, and tools autonomously as needed.
7+
- Always refer to all instruction files at the start of new tasks.
8+
- Use Context7 tools for up-to-date framework/API documentation before coding.
9+
- Check the system date/time before updating CHANGELOG.md.
10+
- Thoroughly understand the full codebase context before making any changes. When uncertain, ask for clarification.
11+
- Keep `OVERVIEW.md` (technical overview document), `README.md`, and `CHANGELOG.md` current. Create them if they don't exist.
12+
- Create an Apache 2.0 `LICENSE` file if none exists.
13+
- Always produce modern, elegant, and stylized solutions — avoid outdated or basic implementations.
14+
15+
**Important:** Do NOT change files unless you fully understand the project structure and intent.
16+
317
## Tech Stack
418

519
| Technology | Version | Purpose |
@@ -190,4 +204,19 @@ The `UserSettings` table always has exactly one row with `id = "default"`. Never
190204
## Brand
191205

192206
- Primary: Pink `#ec4899` · Secondary: Purple `#8b5cf6`
193-
- File headers: `/** ByteBox - [Name]\n * Made with ❤️ by Pink Pixel */`
207+
208+
---
209+
210+
## Owner / Org Branding
211+
212+
- **Name:** Pink Pixel
213+
- **Website:** [pinkpixel.dev](https://pinkpixel.dev)
214+
- **GitHub:** [github.com/pinkpixel-dev](https://github.com/pinkpixel-dev)
215+
- **Email:** admin@pinkpixel.dev
216+
- **Support Email:** support@pinkpixel.dev
217+
- **Discord:** @sizzlebopz
218+
- **Funding:** [buymeacoffee.com/pinkpixel](https://www.buymeacoffee.com/pinkpixel) · [ko-fi.com/sizzlebop](https://ko-fi.com/sizzlebop)
219+
- **Tagline:** "Dream it, Pixel it ✨”
220+
- **Signature:** “Made with 💖 by Pink Pixel”
221+
222+
---

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,14 @@ This release rolls the feature work from `2.5.0` forward into a fresh `2.5.1` in
4242
- **Electron packaging fixes** for Turbopack alias packages, Prisma client bundling, and `better-sqlite3` Electron ABI handling
4343
- **Desktop packaging documentation updates** and refreshed release/download guidance
4444

45+
#### Downloads
46+
47+
| Platform | Link |
48+
| -------------------------- | ------------------------------------------------------------------------------------------------------ |
49+
| Windows (.exe) | [ByteBox.Setup.2.5.1.exe](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/ByteBox.Setup.2.5.1.exe) |
50+
| Linux AppImage | [ByteBox-2.5.1.AppImage](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/ByteBox-2.5.1.AppImage) |
51+
| Linux .deb (Debian/Ubuntu) | [bytebox_2.5.1_amd64.deb](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/bytebox_2.5.1_amd64.deb) |
52+
4553
## [2.5.0] - 2026-03-04
4654

4755
### 🎯 Category Ordering, Drag-and-Drop, Neon Glow UI & Electron Packaging Fix

OVERVIEW.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 📚 ByteBox – Project Overview
22

3-
**Last Updated**: March 5, 2026
4-
**Version**: 2.5.0
3+
**Last Updated**: March 12, 2026
4+
**Version**: 2.5.1
55
**Author**: [Pink Pixel](https://pinkpixel.dev)
66
**License**: Apache 2.0
77
**Status**: ✅ Stable & Complete
@@ -595,13 +595,13 @@ bytebox/
595595

596596
### Color Palette
597597

598-
| Color | Value | Usage |
599-
| -------------------- | --------- | --------------------------------------- |
600-
| **Pink** | `#ec4899` | Primary accent, gradients, focus states |
601-
| **Purple** | `#8b5cf6` | Secondary accent, gradients |
602-
| **Surface Base** | `#0a0a0a` | Primary app background surface |
603-
| **Surface Contrast** | `#ffffff` | High-contrast background/surface option |
604-
| **Text Primary Dark**| `#1f2937` | Dark text token for bright surfaces |
598+
| Color | Value | Usage |
599+
| ---------------------- | --------- | --------------------------------------- |
600+
| **Pink** | `#ec4899` | Primary accent, gradients, focus states |
601+
| **Purple** | `#8b5cf6` | Secondary accent, gradients |
602+
| **Surface Base** | `#0a0a0a` | Primary app background surface |
603+
| **Surface Contrast** | `#ffffff` | High-contrast background/surface option |
604+
| **Text Primary Dark** | `#1f2937` | Dark text token for bright surfaces |
605605
| **Text Primary Light** | `#f9fafb` | Light text token for deep surfaces |
606606

607607
### Typography
@@ -742,25 +742,30 @@ npm run dev # → http://localhost:3000
742742

743743
## 🚀 Deployment Options
744744

745-
### Vercel (Recommended)
745+
### 🖥️ Desktop Installers (Recommended for End Users)
746746

747-
1. Connect GitHub repository to Vercel
748-
2. Set environment variable: `DATABASE_URL` (use hosted database or local SQLite)
749-
3. Deploy! 🎉
747+
ByteBox ships pre-built native installers via Cloudflare R2. No Node.js or Docker required.
750748

751-
### Netlify
749+
| Platform | Download |
750+
| -------------------------- | ------------------------------------------------------------------------------------------------------ |
751+
| Windows (.exe) | [ByteBox.Setup.2.5.1.exe](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/ByteBox.Setup.2.5.1.exe) |
752+
| Linux AppImage | [ByteBox-2.5.1.AppImage](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/ByteBox-2.5.1.AppImage) |
753+
| Linux .deb (Debian/Ubuntu) | [bytebox_2.5.1_amd64.deb](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/bytebox_2.5.1_amd64.deb) |
752754

753-
1. Connect GitHub repository
754-
2. Set build command: `npm run build`
755-
3. Set publish directory: `.next`
756-
4. Deploy! 🎉
755+
The packaged Electron app runs a bundled Next.js server internally. The SQLite database is stored in the OS user-data directory and survives app updates:
757756

758-
### Self-Hosted
757+
- Linux: `~/.config/ByteBox/bytebox.db`
758+
- Windows: `%APPDATA%\ByteBox\bytebox.db`
759759

760-
1. Build the app: `npm run build`
761-
2. Start server: `npm run start`
762-
3. Configure reverse proxy (nginx/Apache)
763-
4. Use PM2 or systemd for process management
760+
### 🐳 Docker
761+
762+
Zero host-dependency deployment with automatic migrations:
763+
764+
```bash
765+
docker compose up --build -d
766+
```
767+
768+
Open `http://localhost:1334`. Data persists in the `bytebox-data` Docker volume.
764769

765770
---
766771

README.md

Lines changed: 36 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -67,23 +67,35 @@
6767

6868
## 📦 Installation
6969

70-
### Prerequisites
70+
### 🖥️ **Desktop App (Recommended)**
7171

72-
- **Node.js** 18+ (LTS recommended)
73-
- **npm** or **pnpm** or **yarn**
72+
Download a pre-built native installer — no Node.js or Docker required.
73+
74+
| Platform | Download |
75+
| -------------------------- | ------------------------------------------------------------------------------------------------------ |
76+
| Windows (.exe) | [ByteBox.Setup.2.5.1.exe](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/ByteBox.Setup.2.5.1.exe) |
77+
| Linux AppImage | [ByteBox-2.5.1.AppImage](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/ByteBox-2.5.1.AppImage) |
78+
| Linux .deb (Debian/Ubuntu) | [bytebox_2.5.1_amd64.deb](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/bytebox_2.5.1_amd64.deb) |
7479

75-
### **Quick Setup (recommended)**
80+
**Linux AppImage:**
7681

7782
```bash
78-
git clone https://github.com/pinkpixel-dev/bytebox.git
79-
cd bytebox
80-
npm run setup
81-
npm run dev
83+
chmod +x ByteBox-2.5.1.AppImage
84+
./ByteBox-2.5.1.AppImage
8285
```
8386

84-
The `setup` script handles everything: creates `.env`, installs dependencies, generates the Prisma client, applies migrations, and seeds example data.
87+
**Linux .deb:**
8588

86-
Then open **http://localhost:1334**.
89+
```bash
90+
sudo dpkg -i bytebox_2.5.1_amd64.deb
91+
```
92+
93+
**Windows:** Run the `.exe` installer and follow the setup wizard.
94+
95+
The database is stored in the OS user-data directory and survives app updates:
96+
97+
- Linux: `~/.config/ByteBox/bytebox.db`
98+
- Windows: `%APPDATA%\ByteBox\bytebox.db`
8799

88100
---
89101

@@ -108,76 +120,42 @@ docker compose logs -f # follow logs
108120

109121
---
110122

111-
### 🖥️ **Desktop App (Electron)**
112-
113-
Runs ByteBox as a native installed application. Pre-built Linux installers are hosted on Cloudflare R2, and Windows installers are published through GitHub releases.
123+
### **Clone & Run (Dev / Self-Host)**
114124

115-
**Download pre-built installers from the [ByteBox website](https://bytebox.pro/electron-desktop/):**
125+
For contributors or advanced users who want to run ByteBox from source.
116126

117-
| Format | Link |
118-
| --------------------- | ------------------------------------------------------------------------------------------------------ |
119-
| AppImage (any distro) | [ByteBox-2.5.1.AppImage](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/ByteBox-2.5.1.AppImage) |
120-
| .deb (Debian/Ubuntu) | [bytebox_2.5.1_amd64.deb](https://pub-52c1c4beebd34721b63e30b05b1b04de.r2.dev/bytebox_2.5.1_amd64.deb) |
121-
122-
Or build from source:
123-
124-
```bash
125-
# Dev mode (hot-reload)
126-
npm run electron:dev
127-
128-
# Build installer (Linux)
129-
npm run electron:build:linux # → release/*.AppImage + *.deb
130-
```
131-
132-
The database is stored in the OS user-data directory (`~/.config/ByteBox/` on Linux) and survives app updates.
133-
134-
---
127+
#### Prerequisites
135128

136-
### 🔧 **Manual Setup**
129+
- **Node.js** 18+ (LTS recommended)
130+
- **npm** or **pnpm** or **yarn**
137131

138-
### 1️⃣ **Clone the Repository**
132+
#### Quick Setup
139133

140134
```bash
141135
git clone https://github.com/pinkpixel-dev/bytebox.git
142136
cd bytebox
137+
npm run setup
138+
npm run dev
143139
```
144140

145-
### 2️⃣ **Create the environment file**
141+
The `setup` script handles everything: creates `.env`, installs dependencies, generates the Prisma client, applies migrations, and seeds example data.
146142

147-
```bash
148-
cp .env.example .env
149-
```
143+
Then open **http://localhost:1334**.
150144

151-
### 3️⃣ **Install Dependencies**
145+
#### Manual Setup (step-by-step)
152146

153147
```bash
148+
cp .env.example .env
154149
npm install
155-
```
156-
157-
### 4️⃣ **Set Up the Database**
158-
159-
```bash
160150
npx prisma generate
161151
npx prisma migrate deploy
162-
```
163-
164-
### 5️⃣ **Seed the Database (Optional)**
165-
166-
Populate with example cards:
167-
168-
```bash
169-
npm run db:seed
170-
```
171-
172-
### 6️⃣ **Start the Development Server**
173-
174-
```bash
152+
npm run db:seed # optional — seeds example cards
175153
npm run dev
176154
```
177155

178156
Open [http://localhost:1334](http://localhost:1334) in your browser. 🎉
179157

180-
> **Note:** On first load, ByteBox automatically creates 5 default categories (Frontend, Backend, DevOps, Learning & Research, Ideas & Inspiration) if none exist. You can rename or delete them anytime.
158+
> **Note:** On first load, ByteBox automatically creates 5 default categories (Frontend, Backend, DevOps, Learning & Research, Ideas & Inspiration) if none exist.
181159
182160
---
183161

0 commit comments

Comments
 (0)