Compare commits

...

4 Commits

Author SHA1 Message Date
a1d47f2536 CUB-114: Update Pi 5 kiosk deployment for Go + React stack
All checks were successful
Dev Build / build-test (pull_request) Successful in 1m22s
2026-05-19 14:12:14 -04:00
10c9340e74 Merge pull request 'CUB-133: Build Dashboard page with summary cards' (#42) from agent/rex/CUB-133-dashboard-page into dev
All checks were successful
Dev Build / build-test (push) Successful in 1m34s
Reviewed-on: #42
2026-05-15 10:58:22 -04:00
ffff4213b6 Merge branch 'dev' into agent/rex/CUB-133-dashboard-page - resolve App.tsx conflict
All checks were successful
Dev Build / build-test (pull_request) Successful in 1m23s
2026-05-12 15:51:21 -04:00
32798fbf14 CUB-133: Build Dashboard page with summary cards
All checks were successful
Dev Build / build-test (pull_request) Successful in 2m10s
2026-05-07 20:07:45 -04:00
16 changed files with 584 additions and 19 deletions

View File

@@ -1,34 +1,37 @@
#!/bin/bash
set -e
echo "🔧 Deploying Extrudex Docker runtime..."
echo "🔧 Deploying Extrudex (Go + React) on Raspberry Pi..."
# Check if Docker Compose is available
if ! command -v docker-compose &> /dev/null && ! docker compose version &> /dev/null; then
if ! docker compose version &>/dev/null && ! command -v docker-compose &>/dev/null; then
echo "❌ Docker Compose is not installed"
exit 1
fi
COMPOSE_CMD="docker compose"
if command -v docker-compose &> /dev/null; then
if command -v docker-compose &>/dev/null; then
COMPOSE_CMD="docker-compose"
fi
echo "📦 Building and starting services..."
echo "📦 Building and starting Go backend + React frontend + PostgreSQL..."
$COMPOSE_CMD -f docker-compose.dev.yml up -d --build
echo "⏳ Waiting for services to become healthy..."
sleep 15
sleep 10
echo "✅ Deployment complete!"
echo ""
echo "Services running:"
echo " • PostgreSQL: localhost:5433"
echo " • Extrudex API: http://localhost:5080"
echo " • Extrudex Web: http://localhost:5081"
echo " • Extrudex API (Go): http://localhost:5080"
echo " • Extrudex Web (React): http://localhost:5081"
echo ""
echo "Barcode scanner: HID keyboard input — focus any text field to start scanning."
echo "Kiosk mode: Chromium auto-starts on boot via systemd (extrudex-kiosk.service)."
echo ""
echo "To view logs:"
echo " $COMPOSE_CMD -f docker-compose.dev.yml logs -f"
echo ""
echo "To stop:"
echo " $COMPOSE_CMD -f docker-compose.dev.yml down"
echo " $COMPOSE_CMD -f docker-compose.dev.yml down"

View File

@@ -28,13 +28,10 @@ services:
ports:
- "5080:8080"
environment:
- ASPNETCORE_ENVIRONMENT=Development
- ASPNETCORE_URLS=http://+:8080
- EXTRUDEX_DB_HOST=extrudex-db
- EXTRUDEX_DB_PORT=5432
- EXTRUDEX_DB_NAME=extrudex
- EXTRUDEX_DB_USER=extrudex
- EXTRUDEX_DB_PASSWORD=changeme
- DATABASE_URL=postgres://extrudex:changeme@extrudex-db:5432/extrudex?sslmode=disable
- PORT=8080
- CORS_ORIGIN=*
- LOG_LEVEL=info
depends_on:
extrudex-db:
condition: service_healthy
@@ -44,7 +41,7 @@ services:
interval: 30s
timeout: 10s
retries: 3
start_period: 40s
start_period: 15s
networks:
- extrudex-network

168
docs/PI-KIOSK-SETUP.md Normal file
View File

@@ -0,0 +1,168 @@
# Pi 5 Kiosk Setup — Extrudex (Go + React)
## Prerequisites
- Raspberry Pi 5 (4 GB or 8 GB)
- MicroSD card (32 GB minimum, Class 10+)
- HDMI touchscreen display
- USB barcode scanner (HID keyboard mode)
- Power supply (27W USB-C recommended)
## One-Line Setup
```bash
# 1. Install Raspberry Pi OS (64-bit, Desktop)
# 2. Enable SSH and VNC
# 3. Run the automated bootstrap
curl -sSL https://raw.githubusercontent.com/CubeCraft-Creations/Extrudex/dev/scripts/pi-bootstrap.sh | bash
```
Or follow the manual steps below.
## Manual Setup
### 1. Install Docker
```bash
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker pi
```
Log out and back in for group changes to take effect.
### 2. Clone and deploy
```bash
cd /home/pi
git clone https://code.cubecraftcreations.com/CubeCraft-Creations/Extrudex.git
cd Extrudex
git checkout dev
# Run the deploy script
chmod +x deploy.sh
./deploy.sh
```
### 3. Verify services
```bash
docker compose -f docker-compose.dev.yml ps
# All three services should be "Up"
```
Check the health endpoint:
```bash
curl http://localhost:5080/health
# Expected: {"status":"ok","db_connected":true,"timestamp":"..."}
```
### 4. Configure kiosk auto-start
```bash
# Enable the Docker stack service (starts on boot)
sudo cp systemd/extrudex.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable extrudex.service
# Enable the kiosk service (starts Chromium after Docker stack)
sudo cp systemd/extrudex-kiosk.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable extrudex-kiosk.service
```
### 5. Configure display server
For Pi 5, Raspberry Pi OS uses Wayland by default. If you encounter
X11-specific issues, switch to X11 in raspi-config (Advanced Options →
Resolution → X11).
The kiosk service supports both Wayland and X11 display servers.
### 6. Touchscreen calibration (if needed)
```bash
# Install calibration tools
sudo apt install -y xinput-calibrator
# Run calibration, note the device ID and parameters
xinput_calibrator
```
Add the calibration to `~/.config/labwc/labwc.conf` or `/etc/X11/xorg.conf.d/`
as appropriate for your display server.
## USB Barcode Scanner
The USB barcode scanner works as a HID keyboard device — it types scanned
codes followed by an Enter keypress. No driver configuration is needed.
On the React frontend, the search input auto-focuses on page load and
will capture barcode input immediately. After a touch on another element,
tap the search field again to re-focus.
## Auto-Refresh on Wake
The React app polls the SSE endpoint every 30 seconds for real-time
updates. When the Pi wakes from sleep, the next poll will immediately
sync the UI.
The kiosk service has `Restart=always` and `RestartSec=10`, so Chromium
will restart within 10 seconds of any crash or power cycle.
## Touch Gestures
Chromium is launched with `--touch-events=enabled` and `--enable-pinch`
for native touch gesture support:
- **Tap** — click/submit
- **Two-finger scroll** — page scrolling
- **Pinch** — zoom (disabled in kiosk mode by default; enable if needed)
## Troubleshooting
### Services not starting
```bash
sudo systemctl status extrudex
sudo systemctl status extrudex-kiosk
docker compose -f docker-compose.dev.yml logs
```
### Kiosk shows blank page
- Ensure Docker stack is running: `docker compose ps`
- Check nginx is serving the React build: `curl http://localhost:5081`
- Check Chromium logs: `journalctl -u extrudex-kiosk -n 50`
### Barcode not working
- Verify scanner is in HID keyboard mode (most USB scanners default to this)
- Open a text field and scan — you should see digits appear
- Check with `dmesg | grep -i usb` for device enumeration
### PostgreSQL connection refused
```bash
docker compose -f docker-compose.dev.yml restart extrudex-db
# Wait 15 seconds, then check health
curl http://localhost:5080/health
```
## Architecture
```
┌──────────────────────────────────────────────┐
│ Pi 5 (Raspberry Pi OS 64-bit) │
│ │
│ ┌─────────────┐ ┌──────────┐ ┌─────────┐ │
│ │ Chromium │ │ Nginx │ │ Go │ │
│ │ Kiosk │→│ (React) │→│ API │ │
│ │ :5081 │ │ :5080 │ │ :8080 │ │
│ └─────────────┘ └──────────┘ └────┬────┘ │
│ │ │
│ ┌────────▼────┐ │
│ │ PostgreSQL │ │
│ │ :5432 │ │
│ └─────────────┘ │
│ │
│ ┌──────────┐ │
│ │ USB │ │
│ │ Scanner │ → HID keyboard → Browser │
│ └──────────┘ │
└──────────────────────────────────────────────┘
```

View File

@@ -10,7 +10,7 @@ server {
}
location /api/ {
proxy_pass http://backend:8080/api/;
proxy_pass http://extrudex-api:8080/api/;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection 'upgrade';

View File

@@ -1,5 +1,6 @@
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { BrowserRouter, Routes, Route } from 'react-router-dom'
import Dashboard from './pages/Dashboard'
import InventoryPage from './pages/InventoryPage'
const queryClient = new QueryClient()
@@ -15,7 +16,8 @@ export default function App() {
</header>
<main className="p-4">
<Routes>
<Route path="/" element={<InventoryPage />} />
<Route path="/" element={<Dashboard />} />
<Route path="/inventory" element={<InventoryPage />} />
</Routes>
</main>
</div>

View File

@@ -0,0 +1,8 @@
export default function LoadingSpinner() {
return (
<div className="flex flex-col items-center gap-3">
<div className="w-10 h-10 border-4 border-emerald-500/30 border-t-emerald-400 rounded-full animate-spin" />
<p className="text-slate-400 text-sm">Loading dashboard</p>
</div>
)
}

View File

@@ -0,0 +1,76 @@
import type { PrintJob } from '../types'
import { Clock, FileText } from 'lucide-react'
interface RecentPrintsProps {
jobs: PrintJob[]
}
export default function RecentPrints({ jobs }: RecentPrintsProps) {
if (jobs.length === 0) {
return (
<div className="rounded-xl border border-slate-700 bg-slate-800 p-6 text-center text-slate-400">
<FileText size={32} className="mx-auto mb-3 text-slate-500" />
<p>No recent print jobs</p>
</div>
)
}
const statusColor = (status: string) => {
switch (status.toLowerCase()) {
case 'completed': return 'text-emerald-400 bg-emerald-500/10'
case 'in_progress': return 'text-sky-400 bg-sky-500/10'
case 'failed': return 'text-red-400 bg-red-500/10'
default: return 'text-slate-400 bg-slate-500/10'
}
}
return (
<div className="rounded-xl border border-slate-700 bg-slate-800 overflow-hidden">
<div className="overflow-x-auto">
<table className="w-full text-left">
<thead>
<tr className="border-b border-slate-700">
<th className="px-4 py-3 text-sm font-medium text-slate-400">Name</th>
<th className="px-4 py-3 text-sm font-medium text-slate-400">Status</th>
<th className="px-4 py-3 text-sm font-medium text-slate-400">Duration</th>
<th className="px-4 py-3 text-sm font-medium text-slate-400">Filament</th>
<th className="px-4 py-3 text-sm font-medium text-slate-400">Cost</th>
</tr>
</thead>
<tbody>
{jobs.map((job) => (
<tr key={job.id} className="border-b border-slate-700/50 last:border-0 hover:bg-slate-700/30 transition-colors">
<td className="px-4 py-3 text-sm text-slate-100 font-medium">{job.name}</td>
<td className="px-4 py-3">
<span className={`inline-flex items-center gap-1 px-2 py-1 rounded-full text-xs font-medium ${statusColor(job.status)}`}>
{job.status}
</span>
</td>
<td className="px-4 py-3 text-sm text-slate-300">
<div className="flex items-center gap-1">
<Clock size={14} />
{formatDuration(job.duration_seconds)}
</div>
</td>
<td className="px-4 py-3 text-sm text-slate-300">
{job.filament_used_grams?.toFixed(1) ?? '-'} g
</td>
<td className="px-4 py-3 text-sm text-slate-300">
${job.cost_usd?.toFixed(2) ?? '-'}
</td>
</tr>
))}
</tbody>
</table>
</div>
</div>
)
}
function formatDuration(seconds: number): string {
if (!seconds) return '-'
const hrs = Math.floor(seconds / 3600)
const mins = Math.floor((seconds % 3600) / 60)
if (hrs > 0) return `${hrs}h ${mins}m`
return `${mins}m`
}

View File

@@ -0,0 +1,31 @@
import type { LucideIcon } from 'lucide-react'
interface SummaryCardProps {
title: string
value: string | number
icon: LucideIcon
color: 'emerald' | 'amber' | 'sky' | 'violet'
}
const colorMap = {
emerald: { bg: 'bg-emerald-500/10', border: 'border-emerald-500/20', text: 'text-emerald-400', icon: 'text-emerald-400' },
amber: { bg: 'bg-amber-500/10', border: 'border-amber-500/20', text: 'text-amber-400', icon: 'text-amber-400' },
sky: { bg: 'bg-sky-500/10', border: 'border-sky-500/20', text: 'text-sky-400', icon: 'text-sky-400' },
violet: { bg: 'bg-violet-500/10', border: 'border-violet-500/20', text: 'text-violet-400', icon: 'text-violet-400' },
}
export default function SummaryCard({ title, value, icon: Icon, color }: SummaryCardProps) {
const c = colorMap[color]
return (
<div className={`rounded-xl border ${c.border} ${c.bg} p-5 flex items-start justify-between`}>
<div>
<p className="text-sm font-medium text-slate-400 mb-1">{title}</p>
<p className={`text-3xl font-bold ${c.text}`}>{value}</p>
</div>
<div className={`p-2 rounded-lg ${c.bg}`}>
<Icon size={24} className={c.icon} />
</div>
</div>
)
}

View File

@@ -1,10 +1,25 @@
import { StrictMode } from 'react'
import { createRoot } from 'react-dom/client'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { BrowserRouter } from 'react-router-dom'
import './index.css'
import App from './App'
const queryClient = new QueryClient({
defaultOptions: {
queries: {
staleTime: 30_000,
refetchOnWindowFocus: false,
},
},
})
createRoot(document.getElementById('root')!).render(
<StrictMode>
<App />
<QueryClientProvider client={queryClient}>
<BrowserRouter>
<App />
</BrowserRouter>
</QueryClientProvider>
</StrictMode>,
)

View File

@@ -0,0 +1,139 @@
import { useQuery } from '@tanstack/react-query'
import { getFilaments, getPrintJobs } from '../services/api'
import SummaryCard from '../components/SummaryCard'
import RecentPrints from '../components/RecentPrints'
import LoadingSpinner from '../components/LoadingSpinner'
import { Package, AlertTriangle, Printer, DollarSign, Plus, List } from 'lucide-react'
export default function Dashboard() {
const {
data: filamentData,
isLoading: filamentLoading,
error: filamentError,
} = useQuery({
queryKey: ['filaments', 'count'],
queryFn: () => getFilaments({ limit: 1 }),
})
const {
data: lowStockData,
isLoading: lowStockLoading,
error: lowStockError,
} = useQuery({
queryKey: ['filaments', 'lowStock'],
queryFn: () => getFilaments({ low_stock: true, limit: 1 }),
})
const {
data: recentPrints,
isLoading: printsLoading,
error: printsError,
} = useQuery({
queryKey: ['printJobs', 'recent'],
queryFn: () => getPrintJobs({ limit: 5 }),
})
const {
data: allPrints,
isLoading: costLoading,
error: costError,
} = useQuery({
queryKey: ['printJobs', 'all'],
queryFn: () => getPrintJobs({ limit: 1000 }),
})
const totalSpools = filamentData?.total ?? 0
const lowStockCount = lowStockData?.total ?? 0
const recentPrintJobs = recentPrints?.data ?? []
// Calculate cost this month from all print jobs
const now = new Date()
const currentMonth = now.getMonth()
const currentYear = now.getFullYear()
const monthlyCost =
allPrints?.data
.filter((job) => {
const d = new Date(job.started_at)
return d.getMonth() === currentMonth && d.getFullYear() === currentYear
})
.reduce((sum, job) => sum + (job.cost_usd ?? 0), 0) ?? 0
const isLoading = filamentLoading || lowStockLoading || printsLoading || costLoading
const error = filamentError || lowStockError || printsError || costError
if (isLoading) {
return (
<div className="min-h-screen flex items-center justify-center bg-slate-900">
<LoadingSpinner />
</div>
)
}
if (error) {
return (
<div className="min-h-screen flex items-center justify-center bg-slate-900">
<div className="p-6 rounded-lg bg-red-900/30 border border-red-500 text-red-200 max-w-md">
<h2 className="text-xl font-bold mb-2">Error</h2>
<p className="text-sm">{(error as Error).message || 'Failed to load dashboard data.'}</p>
</div>
</div>
)
}
return (
<div className="min-h-screen bg-slate-900 p-4 md:p-8">
<div className="max-w-6xl mx-auto">
<header className="mb-8">
<h1 className="text-3xl font-bold text-emerald-400 mb-2">Dashboard</h1>
<p className="text-slate-400">Overview of your Extrudex inventory and prints</p>
</header>
{/* Summary Cards Grid */}
<div className="grid grid-cols-1 sm:grid-cols-2 lg:grid-cols-4 gap-4 mb-8">
<SummaryCard
title="Total Spools"
value={totalSpools}
icon={Package}
color="emerald"
/>
<SummaryCard
title="Low Stock"
value={lowStockCount}
icon={AlertTriangle}
color={lowStockCount > 0 ? 'amber' : 'emerald'}
/>
<SummaryCard
title="Recent Prints"
value={recentPrintJobs.length}
icon={Printer}
color="sky"
/>
<SummaryCard
title="Cost This Month"
value={`$${monthlyCost.toFixed(2)}`}
icon={DollarSign}
color="violet"
/>
</div>
{/* Quick Actions */}
<div className="flex flex-wrap gap-3 mb-8">
<button className="flex items-center gap-2 px-4 py-2 rounded-lg bg-emerald-600 hover:bg-emerald-500 text-white font-medium transition-colors active:scale-95 touch-manipulation">
<Plus size={18} />
Add Spool
</button>
<button className="flex items-center gap-2 px-4 py-2 rounded-lg bg-slate-700 hover:bg-slate-600 text-slate-100 font-medium transition-colors active:scale-95 touch-manipulation">
<List size={18} />
View Inventory
</button>
</div>
{/* Recent Prints Section */}
<section>
<h2 className="text-xl font-semibold text-slate-100 mb-4">Recent Prints</h2>
<RecentPrints jobs={recentPrintJobs} />
</section>
</div>
</div>
)
}

View File

@@ -0,0 +1,19 @@
import axios from 'axios'
import type { ListResponse, FilamentSpool, PrintJob } from '../types'
const api = axios.create({
baseURL: '/api',
headers: { 'Content-Type': 'application/json' },
})
export async function getFilaments(params?: { low_stock?: boolean; limit?: number; offset?: number }) {
const res = await api.get<ListResponse<FilamentSpool>>('/filaments', { params })
return res.data
}
export async function getPrintJobs(params?: { limit?: number; offset?: number }) {
const res = await api.get<ListResponse<PrintJob>>('/print-jobs', { params })
return res.data
}
export default api

View File

@@ -0,0 +1,42 @@
export interface FilamentSpool {
id: number;
name: string;
material_base_id: number;
material_finish_id: number;
material_modifier_id: number;
color_hex: string;
brand: string;
diameter_mm: number;
initial_grams: number;
remaining_grams: number;
spool_weight_grams: number;
cost_usd: number;
low_stock_threshold_grams: number;
notes: string;
barcode: string;
created_at: string;
updated_at: string;
deleted_at: string | null;
}
export interface PrintJob {
id: number;
name: string;
printer_id: number;
filament_id: number;
status: string;
duration_seconds: number;
filament_used_grams: number;
cost_usd: number;
started_at: string;
completed_at: string | null;
created_at: string;
updated_at: string;
}
export interface ListResponse<T> {
data: T[];
total: number;
limit: number;
offset: number;
}

View File

@@ -15,6 +15,7 @@
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true,
"ignoreDeprecations": "5.0",
"baseUrl": ".",
"paths": {
"@/*": ["src/*"]

View File

@@ -0,0 +1,36 @@
[Unit]
Description=Extrudex Kiosk (Chromium, Go + React frontend)
After=network-online.target extrudex.service
Requires=extrudex.service
[Service]
Type=simple
User=pi
Group=pi
Environment=DISPLAY=:0
Environment=XAUTHORITY=/home/pi/.Xauthority
WorkingDirectory=/home/pi
ExecStart=/usr/bin/chromium-browser \
--no-first-run \
--no-default-browser-check \
--autoplay-policy=no-user-gesture-required \
--disable-infobars \
--disable-window-activation \
--disable-full-screen-modal \
--kiosk http://localhost:5081 \
--disable-features=TranslateUI \
--touch-events=enabled \
--enable-pinch
ExecReload=/bin/kill -HUP $MAINPID
Restart=always
RestartSec=10
# Touchscreen / kiosk
Environment=QT_QPA_PLATFORM=wayland
Environment=QT_WAYLAND_SHELL_INTEGRATION=wayland
[Install]
WantedBy=multi-user.target

View File

@@ -0,0 +1,12 @@
[Unit]
Description=Extrudex Kiosk Session (user-level, seat %i)
After=graphical-session.target
[Service]
Type=simple
Environment=DISPLAY=:0
ExecStart=/bin/true
Restart=on-failure
[Install]
WantedBy=graphical-session.target

16
systemd/extrudex.service Normal file
View File

@@ -0,0 +1,16 @@
[Unit]
Description=Extrudex Docker Compose Stack (Go + React)
After=network-online.target docker.service
Requires=docker.service
[Service]
Type=oneshot
RemainAfterExit=yes
WorkingDirectory=/home/pi/extrudex
ExecStart=/usr/bin/docker compose -f docker-compose.dev.yml up -d
ExecStop=/usr/bin/docker compose -f docker-compose.dev.yml down
TimeoutStartSec=120
TimeoutStopSec=120
[Install]
WantedBy=multi-user.target