Last Sync: 2026-01-26 18:20 (Mobile)

Author: potatameister

.github/workflows/android.yml

@@ -10,15 +10,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Setup Java
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
           java-version: '17'
@@ -39,7 +39,7 @@ jobs:
         run: ./gradlew assembleDebug
 
       - name: Upload APK
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: paperknife-debug
           path: android/app/build/outputs/apk/debug/app-debug.apk

README.md

@@ -1,20 +1,70 @@
-<div align="center">
-<img width="1200" height="475" alt="GHBanner" src="https://github.com/user-attachments/assets/0aa67016-6eaf-458a-adb2-6e31a0763ed6" />
-</div>
+# PaperKnife 🇨🇭
 
-# Run and deploy your AI Studio app
+> "Code by intuition. Design by logic."
 
-This contains everything you need to run your app locally.
+**PaperKnife** is a privacy-first, offline Swiss Army Knife for PDF operations. It operates entirely within your browser (or on your device via Android APK), ensuring your documents never leave your possession.
 
-View your app in AI Studio: https://ai.studio/apps/drive/1O4JnZamNVOPpCRc1ZkekRh5qheb0Dg3m
+## 🎨 The Aesthetic (Swiss Style)
 
-## Run Locally
+- **Layout:** Bento Grid (Functional, modular boxes).
+- **Typography:** Inter (Clean, grotesque sans-serif).
+- **Palette:** High-contrast Black & White with **Swiss Red** accents for action.
+- **Vibe:** Precision tool. No soft shadows. No fluff.
 
-**Prerequisites:**  Node.js
+## 🛠 The Tech Stack
 
+- **Core:** React 18 + TypeScript
+- **Build Tool:** Vite
+- **Styling:** Tailwind CSS (Utility-first)
+- **Engine:** `pdf-lib` (Client-side PDF manipulation)
+- **Mobile Bridge:** Capacitor (Converts React to Android)
 
-1. Install dependencies:
-   `npm install`
-2. Set the `GEMINI_API_KEY` in [.env.local](.env.local) to your Gemini API key
-3. Run the app:
-   `npm run dev`
+## 🤖 The Factory (Automated Builds)
+
+This project uses **GitHub Actions** to automatically build an Android APK whenever you push to the `main` branch.
+
+1. **Push Code:** Commit changes to `main`.
+2. **Robot Wakes Up:** The workflow in `.github/workflows/android.yml` triggers.
+3. **Build:** It installs Node, Java, builds the React app, and runs the Gradle build.
+4. **Deliver:** The resulting `.apk` file is uploaded as an artifact named `paperknife-debug`.
+
+### Download the APK
+1. Go to the **Actions** tab in this repository.
+2. Click on the latest workflow run.
+3. Scroll down to **Artifacts** and download `paperknife-debug`.
+
+## 💻 Local Development
+
+If you want to run this locally:
+
+```bash
+# 1. Install dependencies
+npm install
+
+# 2. Run the web dev server
+npm run dev
+
+# 3. Build for production
+npm run build
+```
+
+## 📱 Mobile Development (Android)
+
+To run on an Android emulator or device locally:
+
+```bash
+# 1. Build the web assets
+npm run build
+
+# 2. Add Android platform (first time only)
+npx cap add android
+
+# 3. Sync web code to Android
+npx cap sync
+
+# 4. Open Android Studio
+npx cap open android
+```
+
+---
+*Built by Potatameister - The Vibecoder*