privateapp

# PrivateApp

Personal PWA dashboard — FastAPI backend + React/Vite frontend with plugin apps.

## Screenshots

![Home](assets/screenshots/home.png)
![System](assets/screenshots/system.png)
![Files](assets/screenshots/files.png)

## Setup

```bash
# Clone and install (creates venv, builds frontends, sets up systemd/launchd)
git clone https://github.com/camopel/PrivateApp.git ~/Workspace/PrivateApp
cd ~/Workspace/PrivateApp
bash scripts/install.sh [--port 8800]
```

Copy `scripts/config.example.json` → `scripts/config.json` and edit:
```json
{
  "host": "0.0.0.0",
  "port": 8800,
  "data_dir": "~/.local/share/privateapp",
  "file_browser": { "root": "~" },
  "push": { "vapid_email": "you@example.com" }
}
```

## Service Management

```bash
# Linux (systemd user service)
systemctl --user start privateapp
systemctl --user stop privateapp
systemctl --user restart privateapp
systemctl --user status privateapp

# macOS (launchd)
launchctl load ~/Library/LaunchAgents/com.privateapp.server.plist
launchctl unload ~/Library/LaunchAgents/com.privateapp.server.plist

# Manual
.venv/bin/python3 scripts/server.py --host 127.0.0.1 --port 8800
```

## Build Frontends

After any frontend change, rebuild:
```bash
# Build shell (home screen)
cd frontend && npm run build

# Build all app frontends
for app_dir in apps/*/frontend; do
  [ -f "$app_dir/package.json" ] && (cd "$app_dir" && npm install && npm run build)
done

# Or use the install script which builds everything
bash scripts/install.sh
```

Then restart the service.

## Built-in Apps

| App | Shortcode | Description |
|-----|-----------|-------------|
| 📊 System | `sysmon` | CPU, RAM, disk, GPU stats and service health |
| 📁 Files | `files` | Browse, preview, and share files |

## Adding a New App

Create `apps/{app-id}/` with:
- `app.json` — metadata (id, name, shortcode, icon, description)
- `backend/routes.py` — FastAPI router (mounted at `/api/app/{shortcode}/`)
- `frontend/` — React SPA (Vite, builds to `frontend/dist/`...

# PrivateApp

**PrivateApp** is a personal PWA dashboard for your home server. Install it on your phone's home screen for a native-like app with system monitoring and file browsing — all served privately over Tailscale VPN.

## Screenshots

![Home](docs/screenshots/home.png)
![System](docs/screenshots/system.png)
![Files](docs/screenshots/files.png)

## Apps

| App | Description |
|-----|-------------|
| 📊 **System** | Real-time CPU, RAM, disk, GPU stats and service health |
| 📁 **File Browser** | Browse, preview, and share files from your server |

## Requirements

- Python 3.9+
- Node.js 18+ (for building frontend)
- macOS or Linux
- [Tailscale](https://tailscale.com/download) (optional, for remote HTTPS access)

## Install

```bash
git clone https://github.com/camopel/PrivateApp.git
cd PrivateApp
bash scripts/install.sh
```

The install script:
- Creates a Python venv and installs dependencies
- Prompts for VAPID email and generates push notification keys
- Builds the React frontend
- Creates a systemd service (Linux) or launchd plist (macOS)
- Configures Tailscale HTTPS serve (if available)

## Start

```bash
.venv/bin/python3 scripts/server.py
```

Or via system service:
```bash
# Linux
systemctl --user start privateapp

# macOS
launchctl load ~/Library/LaunchAgents/com.privateapp.server.plist
```

Then add to your phone's home screen:
- **iPhone:** Safari → Share → "Add to Home Screen"
- **Android:** Chrome → Menu → "Install app"

## Configuration

Copy `scripts/config.example.json` to `scripts/config.json`:

```json
{
  "host": "0.0.0.0",
  "port": 8800,
  "data_dir": "~/.local/share/privateapp",
  "file_browser": { "root": "~" },
  "push": { "vapid_email": "you@example.com" }
}
```

| Field | Default | Description |
|-------|---------|-------------|
| `port` | `8800` | HTTP port |
| `data_dir` | `~/.local/share/privateapp` | Push subscriptions, settings |
| `file_browser.root` | `~` | Root directory for File Browser |
| `push.vapid_email` | — | Contact ema...