Compare commits
24 Commits
229cb2cc90
...
feature/is
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8a9f8f7fdd | ||
|
|
bd000649e3 | ||
|
|
1ed51c3667 | ||
|
|
76a229952f | ||
|
|
c5870f9e6f | ||
|
|
0ba695f159 | ||
| 7f9a92994c | |||
|
|
401d40fbe2 | ||
| 915b4fad5f | |||
|
|
2ca3c58f42 | ||
| 5b638ca76f | |||
|
|
f0b555f18a | ||
| 60d6e03e87 | |||
|
|
7209bb06df | ||
| 5b85132114 | |||
|
|
9bdbe9a420 | ||
| 01db4ef8cb | |||
|
|
e47535d0fa | ||
| 28ff53e8cd | |||
|
|
b98b3bf222 | ||
| 7a01aecb34 | |||
|
|
762ec56a3c | ||
| 91a21e274f | |||
|
|
14e5cab7bb |
68
.dockerignore
Normal file
@@ -0,0 +1,68 @@
|
||||
# Dependencies
|
||||
node_modules
|
||||
app/node_modules
|
||||
supabase/node_modules
|
||||
|
||||
# Build outputs
|
||||
.nuxt
|
||||
app/.nuxt
|
||||
.output
|
||||
app/.output
|
||||
dist
|
||||
app/dist
|
||||
|
||||
# Logs
|
||||
*.log
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
pnpm-debug.log*
|
||||
lerna-debug.log*
|
||||
|
||||
# Environment files (use docker env vars instead)
|
||||
.env
|
||||
.env.local
|
||||
.env.*.local
|
||||
app/.env
|
||||
app/.env.local
|
||||
|
||||
# Editor directories and files
|
||||
.vscode/
|
||||
.idea/
|
||||
*.suo
|
||||
*.ntvs*
|
||||
*.njsproj
|
||||
*.sln
|
||||
*.sw?
|
||||
.DS_Store
|
||||
|
||||
# Git
|
||||
.git
|
||||
.gitignore
|
||||
.gitattributes
|
||||
|
||||
# CI/CD
|
||||
.github
|
||||
.gitea
|
||||
|
||||
# Documentation
|
||||
*.md
|
||||
docs/
|
||||
!README.md
|
||||
|
||||
# Tests
|
||||
test/
|
||||
tests/
|
||||
*.spec.js
|
||||
*.spec.ts
|
||||
*.test.js
|
||||
*.test.ts
|
||||
|
||||
# Temporary files
|
||||
*.tmp
|
||||
*.bak
|
||||
*.swp
|
||||
.cache
|
||||
|
||||
# Supabase (handled separately)
|
||||
supabase/
|
||||
12
.env.production.example
Normal file
@@ -0,0 +1,12 @@
|
||||
# Production Environment Variables
|
||||
# Copy this file to .env.production and fill in your values
|
||||
|
||||
# Supabase Configuration (REQUIRED)
|
||||
# Get these from your Supabase project settings
|
||||
NUXT_PUBLIC_SUPABASE_URL=https://your-project-id.supabase.co
|
||||
NUXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key-here
|
||||
|
||||
# Server Configuration (optional)
|
||||
# HOST=0.0.0.0
|
||||
# PORT=3000
|
||||
# NODE_ENV=production
|
||||
347
DEPLOYMENT.md
Normal file
@@ -0,0 +1,347 @@
|
||||
# Deployment Guide
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Supabase project (managed or self-hosted)
|
||||
- Docker and Docker Compose installed
|
||||
- Domain name (optional, for production)
|
||||
- SSL certificate (for HTTPS, recommended)
|
||||
|
||||
## Quick Start (Docker Compose)
|
||||
|
||||
### 1. Clone the repository
|
||||
|
||||
```bash
|
||||
git clone https://gitea.jeanlucmakiola.de/pantry-app/pantry.git
|
||||
cd pantry
|
||||
```
|
||||
|
||||
### 2. Configure environment
|
||||
|
||||
```bash
|
||||
cp .env.production.example .env.production
|
||||
# Edit .env.production with your Supabase credentials
|
||||
nano .env.production
|
||||
```
|
||||
|
||||
Required environment variables:
|
||||
- `NUXT_PUBLIC_SUPABASE_URL` - Your Supabase project URL
|
||||
- `NUXT_PUBLIC_SUPABASE_ANON_KEY` - Your Supabase anonymous key
|
||||
|
||||
### 3. Build and run
|
||||
|
||||
```bash
|
||||
docker-compose -f docker-compose.prod.yml --env-file .env.production up -d
|
||||
```
|
||||
|
||||
The app will be available at `http://localhost:3000`
|
||||
|
||||
### 4. Verify deployment
|
||||
|
||||
```bash
|
||||
# Check health
|
||||
curl http://localhost:3000/api/health
|
||||
|
||||
# View logs
|
||||
docker-compose -f docker-compose.prod.yml logs -f app
|
||||
|
||||
# Check status
|
||||
docker-compose -f docker-compose.prod.yml ps
|
||||
```
|
||||
|
||||
## Supabase Setup
|
||||
|
||||
### Option 1: Supabase Cloud (Recommended)
|
||||
|
||||
1. Create a free account at [supabase.com](https://supabase.com)
|
||||
2. Create a new project
|
||||
3. Run migrations: `supabase/migrations/*.sql`
|
||||
4. Copy project URL and anon key to `.env.production`
|
||||
|
||||
### Option 2: Self-Hosted Supabase
|
||||
|
||||
Use the included `docker-compose.yml` for local Supabase:
|
||||
|
||||
```bash
|
||||
# Create .env file
|
||||
cp .env.example .env
|
||||
# Edit .env with secure passwords
|
||||
nano .env
|
||||
|
||||
# Start Supabase stack
|
||||
docker-compose up -d
|
||||
|
||||
# Wait for services to be ready
|
||||
docker-compose ps
|
||||
|
||||
# Run migrations
|
||||
docker-compose exec db psql -U postgres -f /docker-entrypoint-initdb.d/001_initial_schema.sql
|
||||
```
|
||||
|
||||
Supabase will be available at:
|
||||
- API: http://localhost:54321
|
||||
- Studio: http://localhost:54323
|
||||
|
||||
## Production Deployment Options
|
||||
|
||||
### Option 1: Coolify (Recommended)
|
||||
|
||||
1. Add new Resource → Docker Compose
|
||||
2. Paste `docker-compose.prod.yml`
|
||||
3. Add environment variables in Coolify UI
|
||||
4. Deploy
|
||||
|
||||
### Option 2: Docker Standalone
|
||||
|
||||
```bash
|
||||
# Build image
|
||||
docker build -t pantry:latest .
|
||||
|
||||
# Run container
|
||||
docker run -d \
|
||||
--name pantry \
|
||||
-p 3000:3000 \
|
||||
-e NUXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co \
|
||||
-e NUXT_PUBLIC_SUPABASE_ANON_KEY=your-key \
|
||||
--restart unless-stopped \
|
||||
pantry:latest
|
||||
```
|
||||
|
||||
### Option 3: Kubernetes
|
||||
|
||||
Example deployment manifest:
|
||||
|
||||
```yaml
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: pantry
|
||||
spec:
|
||||
replicas: 2
|
||||
selector:
|
||||
matchLabels:
|
||||
app: pantry
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: pantry
|
||||
spec:
|
||||
containers:
|
||||
- name: pantry
|
||||
image: pantry:latest
|
||||
ports:
|
||||
- containerPort: 3000
|
||||
env:
|
||||
- name: NUXT_PUBLIC_SUPABASE_URL
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: pantry-secrets
|
||||
key: supabase-url
|
||||
- name: NUXT_PUBLIC_SUPABASE_ANON_KEY
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: pantry-secrets
|
||||
key: supabase-key
|
||||
livenessProbe:
|
||||
httpGet:
|
||||
path: /api/health
|
||||
port: 3000
|
||||
initialDelaySeconds: 40
|
||||
periodSeconds: 30
|
||||
resources:
|
||||
limits:
|
||||
memory: "512Mi"
|
||||
cpu: "1000m"
|
||||
requests:
|
||||
memory: "256Mi"
|
||||
cpu: "500m"
|
||||
```
|
||||
|
||||
### Option 4: VPS with Nginx
|
||||
|
||||
```nginx
|
||||
# /etc/nginx/sites-available/pantry
|
||||
server {
|
||||
listen 80;
|
||||
server_name pantry.yourdomain.com;
|
||||
|
||||
location / {
|
||||
proxy_pass http://localhost:3000;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection 'upgrade';
|
||||
proxy_set_header Host $host;
|
||||
proxy_cache_bypass $http_upgrade;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## HTTPS/SSL
|
||||
|
||||
### Using Let's Encrypt (Certbot)
|
||||
|
||||
```bash
|
||||
# Install Certbot
|
||||
sudo apt install certbot python3-certbot-nginx
|
||||
|
||||
# Get certificate
|
||||
sudo certbot --nginx -d pantry.yourdomain.com
|
||||
|
||||
# Auto-renewal
|
||||
sudo certbot renew --dry-run
|
||||
```
|
||||
|
||||
### Using Cloudflare
|
||||
|
||||
1. Add your domain to Cloudflare
|
||||
2. Enable "Full (strict)" SSL/TLS mode
|
||||
3. Point DNS A record to your server IP
|
||||
4. Cloudflare handles SSL automatically
|
||||
|
||||
## Monitoring
|
||||
|
||||
### Health Checks
|
||||
|
||||
```bash
|
||||
# Manual check
|
||||
curl http://localhost:3000/api/health
|
||||
|
||||
# With watch
|
||||
watch -n 5 'curl -s http://localhost:3000/api/health | jq'
|
||||
```
|
||||
|
||||
### Docker Stats
|
||||
|
||||
```bash
|
||||
docker stats pantry-app
|
||||
```
|
||||
|
||||
### Logs
|
||||
|
||||
```bash
|
||||
# Follow logs
|
||||
docker-compose -f docker-compose.prod.yml logs -f
|
||||
|
||||
# Last 100 lines
|
||||
docker logs --tail 100 pantry-app
|
||||
|
||||
# Since timestamp
|
||||
docker logs --since "2024-01-01T00:00:00" pantry-app
|
||||
```
|
||||
|
||||
## Updating
|
||||
|
||||
### Pull latest changes
|
||||
|
||||
```bash
|
||||
cd pantry
|
||||
git pull origin main
|
||||
|
||||
# Rebuild and restart
|
||||
docker-compose -f docker-compose.prod.yml build
|
||||
docker-compose -f docker-compose.prod.yml up -d
|
||||
```
|
||||
|
||||
### Rolling back
|
||||
|
||||
```bash
|
||||
# Tag before upgrading
|
||||
docker tag pantry:latest pantry:backup-20240101
|
||||
|
||||
# Rollback if needed
|
||||
docker-compose -f docker-compose.prod.yml down
|
||||
docker tag pantry:backup-20240101 pantry:latest
|
||||
docker-compose -f docker-compose.prod.yml up -d
|
||||
```
|
||||
|
||||
## Backup
|
||||
|
||||
### Database (Supabase)
|
||||
|
||||
```bash
|
||||
# Manual backup
|
||||
pg_dump -h localhost -U postgres -d postgres > backup.sql
|
||||
|
||||
# Restore
|
||||
psql -h localhost -U postgres -d postgres < backup.sql
|
||||
```
|
||||
|
||||
### Docker Volumes
|
||||
|
||||
```bash
|
||||
# Backup
|
||||
docker run --rm -v pantry_db-data:/data -v $(pwd):/backup ubuntu tar czf /backup/db-backup.tar.gz /data
|
||||
|
||||
# Restore
|
||||
docker run --rm -v pantry_db-data:/data -v $(pwd):/backup ubuntu tar xzf /backup/db-backup.tar.gz -C /
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Container won't start
|
||||
|
||||
```bash
|
||||
# Check logs
|
||||
docker logs pantry-app
|
||||
|
||||
# Verify environment variables
|
||||
docker exec pantry-app env | grep NUXT
|
||||
|
||||
# Inspect container
|
||||
docker inspect pantry-app
|
||||
```
|
||||
|
||||
### Supabase connection issues
|
||||
|
||||
1. Verify Supabase URL and key
|
||||
2. Check network connectivity
|
||||
3. Verify RLS policies in Supabase
|
||||
4. Check CORS settings
|
||||
|
||||
### Performance issues
|
||||
|
||||
1. Check resource limits
|
||||
2. Monitor with `docker stats`
|
||||
3. Increase memory/CPU limits in docker-compose
|
||||
4. Enable compression in Nginx
|
||||
|
||||
### PWA not updating
|
||||
|
||||
1. Clear browser cache
|
||||
2. Unregister service worker
|
||||
3. Check that service worker is being served with correct headers
|
||||
4. Verify manifest.json is accessible
|
||||
|
||||
## Security Checklist
|
||||
|
||||
- [ ] Use HTTPS (SSL certificate)
|
||||
- [ ] Set secure environment variables
|
||||
- [ ] Don't commit .env files
|
||||
- [ ] Use strong Supabase passwords
|
||||
- [ ] Enable RLS policies in Supabase
|
||||
- [ ] Keep Docker images updated
|
||||
- [ ] Use firewall rules
|
||||
- [ ] Regular backups
|
||||
- [ ] Monitor logs for suspicious activity
|
||||
|
||||
## Performance Optimization
|
||||
|
||||
- Enable CDN (Cloudflare)
|
||||
- Use HTTP/2
|
||||
- Enable gzip/brotli compression
|
||||
- Set proper cache headers
|
||||
- Optimize images
|
||||
- Use Supabase CDN for assets
|
||||
|
||||
## Support
|
||||
|
||||
- Documentation: [docs/](docs/)
|
||||
- Issues: [Gitea Issues](https://gitea.jeanlucmakiola.de/pantry-app/pantry/issues)
|
||||
- Wiki: Coming soon
|
||||
|
||||
---
|
||||
|
||||
**Happy hosting! 🚀**
|
||||
59
Dockerfile
Normal file
@@ -0,0 +1,59 @@
|
||||
# Pantry Production Dockerfile
|
||||
# Multi-stage build for optimized production image
|
||||
|
||||
# Stage 1: Build the Nuxt application
|
||||
FROM node:20-alpine AS builder
|
||||
|
||||
# Set working directory
|
||||
WORKDIR /app
|
||||
|
||||
# Copy package files
|
||||
COPY app/package*.json ./
|
||||
|
||||
# Install dependencies
|
||||
RUN npm ci --only=production && \
|
||||
npm cache clean --force
|
||||
|
||||
# Copy application source
|
||||
COPY app/ ./
|
||||
|
||||
# Build the application
|
||||
RUN npm run build
|
||||
|
||||
# Stage 2: Production runtime
|
||||
FROM node:20-alpine AS runner
|
||||
|
||||
# Install dumb-init for proper signal handling
|
||||
RUN apk add --no-cache dumb-init
|
||||
|
||||
# Create app user
|
||||
RUN addgroup -g 1001 -S nodejs && \
|
||||
adduser -S nodejs -u 1001
|
||||
|
||||
# Set working directory
|
||||
WORKDIR /app
|
||||
|
||||
# Copy built application from builder
|
||||
COPY --from=builder --chown=nodejs:nodejs /app/.output /app/.output
|
||||
COPY --from=builder --chown=nodejs:nodejs /app/package*.json ./
|
||||
|
||||
# Switch to non-root user
|
||||
USER nodejs
|
||||
|
||||
# Expose port
|
||||
EXPOSE 3000
|
||||
|
||||
# Set environment variables
|
||||
ENV NODE_ENV=production \
|
||||
HOST=0.0.0.0 \
|
||||
PORT=3000
|
||||
|
||||
# Health check
|
||||
HEALTHCHECK --interval=30s --timeout=3s --start-period=40s --retries=3 \
|
||||
CMD node -e "require('http').get('http://localhost:3000/api/health', (r) => {process.exit(r.statusCode === 200 ? 0 : 1)})"
|
||||
|
||||
# Use dumb-init to handle signals properly
|
||||
ENTRYPOINT ["dumb-init", "--"]
|
||||
|
||||
# Start the application
|
||||
CMD ["node", ".output/server/index.mjs"]
|
||||
@@ -1,5 +1,9 @@
|
||||
<template>
|
||||
<div>
|
||||
<OfflineBanner />
|
||||
<InstallPrompt />
|
||||
<NuxtLayout>
|
||||
<NuxtPage />
|
||||
</NuxtLayout>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
104
app/components/InstallPrompt.vue
Normal file
@@ -0,0 +1,104 @@
|
||||
<template>
|
||||
<Transition
|
||||
enter-active-class="transition ease-out duration-300"
|
||||
enter-from-class="opacity-0 translate-y-2"
|
||||
enter-to-class="opacity-100 translate-y-0"
|
||||
leave-active-class="transition ease-in duration-200"
|
||||
leave-from-class="opacity-100 translate-y-0"
|
||||
leave-to-class="opacity-0 translate-y-2"
|
||||
>
|
||||
<div
|
||||
v-if="showPrompt"
|
||||
class="fixed bottom-4 left-4 right-4 md:left-auto md:right-4 md:max-w-md z-50"
|
||||
>
|
||||
<div class="bg-white dark:bg-gray-800 rounded-xl shadow-2xl border border-gray-200 dark:border-gray-700 p-4">
|
||||
<div class="flex items-start gap-4">
|
||||
<!-- App Icon -->
|
||||
<div class="flex-shrink-0">
|
||||
<img
|
||||
src="/icon-192x192.png"
|
||||
alt="Pantry icon"
|
||||
class="w-16 h-16 rounded-lg shadow-md"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<!-- Content -->
|
||||
<div class="flex-1 min-w-0">
|
||||
<h3 class="text-lg font-bold text-gray-900 dark:text-white mb-1">
|
||||
Install Pantry
|
||||
</h3>
|
||||
<p class="text-sm text-gray-600 dark:text-gray-400 mb-3">
|
||||
Install this app for quick access and offline use
|
||||
</p>
|
||||
|
||||
<!-- Actions -->
|
||||
<div class="flex gap-2">
|
||||
<UButton
|
||||
color="emerald"
|
||||
size="sm"
|
||||
@click="install"
|
||||
:loading="installing"
|
||||
>
|
||||
<template #leading>
|
||||
<UIcon name="i-heroicons-arrow-down-tray" />
|
||||
</template>
|
||||
Install
|
||||
</UButton>
|
||||
|
||||
<UButton
|
||||
color="gray"
|
||||
variant="ghost"
|
||||
size="sm"
|
||||
@click="dismiss"
|
||||
>
|
||||
Not now
|
||||
</UButton>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Close button -->
|
||||
<button
|
||||
@click="dismiss"
|
||||
class="flex-shrink-0 text-gray-400 hover:text-gray-600 dark:hover:text-gray-300 transition"
|
||||
>
|
||||
<UIcon name="i-heroicons-x-mark" class="w-5 h-5" />
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</Transition>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
const { canInstall, promptInstall, dismissInstall, shouldShowPrompt } = usePWAInstall()
|
||||
const installing = ref(false)
|
||||
const showPrompt = ref(false)
|
||||
|
||||
// Show prompt after a delay if conditions are met
|
||||
onMounted(() => {
|
||||
setTimeout(() => {
|
||||
if (shouldShowPrompt()) {
|
||||
showPrompt.value = true
|
||||
}
|
||||
}, 3000) // Wait 3 seconds after page load
|
||||
})
|
||||
|
||||
async function install() {
|
||||
installing.value = true
|
||||
try {
|
||||
const { outcome } = await promptInstall()
|
||||
if (outcome === 'accepted') {
|
||||
showPrompt.value = false
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('Install failed:', error)
|
||||
} finally {
|
||||
installing.value = false
|
||||
}
|
||||
}
|
||||
|
||||
function dismiss() {
|
||||
dismissInstall()
|
||||
showPrompt.value = false
|
||||
}
|
||||
</script>
|
||||
58
app/components/OfflineBanner.vue
Normal file
@@ -0,0 +1,58 @@
|
||||
<template>
|
||||
<Transition
|
||||
enter-active-class="transition ease-out duration-300"
|
||||
enter-from-class="opacity-0 -translate-y-2"
|
||||
enter-to-class="opacity-100 translate-y-0"
|
||||
leave-active-class="transition ease-in duration-200"
|
||||
leave-from-class="opacity-100 translate-y-0"
|
||||
leave-to-class="opacity-0 -translate-y-2"
|
||||
>
|
||||
<div
|
||||
v-if="!isOnline"
|
||||
class="fixed top-0 left-0 right-0 z-50 bg-amber-500 text-white px-4 py-2 text-center shadow-lg"
|
||||
>
|
||||
<div class="flex items-center justify-center gap-2">
|
||||
<UIcon name="i-heroicons-wifi-slash" class="w-5 h-5" />
|
||||
<span class="font-medium">
|
||||
You're currently offline. Changes will sync when connection is restored.
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
</Transition>
|
||||
|
||||
<Transition
|
||||
enter-active-class="transition ease-out duration-300"
|
||||
enter-from-class="opacity-0 -translate-y-2"
|
||||
enter-to-class="opacity-100 translate-y-0"
|
||||
leave-active-class="transition ease-in duration-200"
|
||||
leave-from-class="opacity-100 translate-y-0"
|
||||
leave-to-class="opacity-0 -translate-y-2"
|
||||
>
|
||||
<div
|
||||
v-if="isOnline && wasOffline && showReconnected"
|
||||
class="fixed top-0 left-0 right-0 z-50 bg-emerald-500 text-white px-4 py-2 text-center shadow-lg"
|
||||
>
|
||||
<div class="flex items-center justify-center gap-2">
|
||||
<UIcon name="i-heroicons-wifi" class="w-5 h-5" />
|
||||
<span class="font-medium">
|
||||
Back online! Syncing your changes...
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
</Transition>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
const { isOnline, wasOffline } = useOnlineStatus()
|
||||
const showReconnected = ref(false)
|
||||
|
||||
// Show "back online" message for 3 seconds
|
||||
watch(isOnline, (online) => {
|
||||
if (online && wasOffline.value) {
|
||||
showReconnected.value = true
|
||||
setTimeout(() => {
|
||||
showReconnected.value = false
|
||||
}, 3000)
|
||||
}
|
||||
})
|
||||
</script>
|
||||
190
app/components/Settings/AppSettings.vue
Normal file
@@ -0,0 +1,190 @@
|
||||
<template>
|
||||
<UCard class="mt-4">
|
||||
<div class="space-y-6">
|
||||
<div>
|
||||
<h3 class="text-lg font-semibold mb-4">App Installation</h3>
|
||||
|
||||
<!-- Already installed -->
|
||||
<div v-if="isInstalled" class="flex items-start gap-3 p-4 bg-emerald-50 dark:bg-emerald-900/20 rounded-lg">
|
||||
<UIcon name="i-heroicons-check-circle" class="w-6 h-6 text-emerald-600 dark:text-emerald-400 flex-shrink-0 mt-0.5" />
|
||||
<div>
|
||||
<p class="font-medium text-emerald-900 dark:text-emerald-100">
|
||||
App is installed
|
||||
</p>
|
||||
<p class="text-sm text-emerald-700 dark:text-emerald-300 mt-1">
|
||||
You're using Pantry as an installed app with offline support.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Can install -->
|
||||
<div v-else-if="canInstall" class="space-y-3">
|
||||
<p class="text-gray-600 dark:text-gray-400">
|
||||
Install Pantry as an app for quick access and offline use.
|
||||
</p>
|
||||
<UButton
|
||||
color="emerald"
|
||||
size="lg"
|
||||
@click="install"
|
||||
:loading="installing"
|
||||
block
|
||||
>
|
||||
<template #leading>
|
||||
<UIcon name="i-heroicons-arrow-down-tray" />
|
||||
</template>
|
||||
Install App
|
||||
</UButton>
|
||||
</div>
|
||||
|
||||
<!-- Not supported or already running -->
|
||||
<div v-else class="space-y-4">
|
||||
<div v-if="isStandalone" class="flex items-start gap-3 p-4 bg-blue-50 dark:bg-blue-900/20 rounded-lg">
|
||||
<UIcon name="i-heroicons-information-circle" class="w-6 h-6 text-blue-600 dark:text-blue-400 flex-shrink-0 mt-0.5" />
|
||||
<div>
|
||||
<p class="font-medium text-blue-900 dark:text-blue-100">
|
||||
Running as standalone app
|
||||
</p>
|
||||
<p class="text-sm text-blue-700 dark:text-blue-300 mt-1">
|
||||
You're already using Pantry in standalone mode.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div v-else>
|
||||
<p class="text-gray-600 dark:text-gray-400 mb-4">
|
||||
Installation is not available yet. Try one of these options:
|
||||
</p>
|
||||
|
||||
<!-- iOS Instructions -->
|
||||
<UCard class="mb-4">
|
||||
<div class="flex items-start gap-3">
|
||||
<UIcon name="i-heroicons-device-phone-mobile" class="w-6 h-6 text-gray-400 flex-shrink-0 mt-0.5" />
|
||||
<div class="flex-1">
|
||||
<h4 class="font-semibold mb-2">iOS (Safari)</h4>
|
||||
<ol class="text-sm text-gray-600 dark:text-gray-400 space-y-1 list-decimal list-inside">
|
||||
<li>Tap the Share button</li>
|
||||
<li>Scroll down and tap "Add to Home Screen"</li>
|
||||
<li>Tap "Add" to confirm</li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</UCard>
|
||||
|
||||
<!-- Android Instructions -->
|
||||
<UCard>
|
||||
<div class="flex items-start gap-3">
|
||||
<UIcon name="i-heroicons-device-phone-mobile" class="w-6 h-6 text-gray-400 flex-shrink-0 mt-0.5" />
|
||||
<div class="flex-1">
|
||||
<h4 class="font-semibold mb-2">Android (Chrome)</h4>
|
||||
<ol class="text-sm text-gray-600 dark:text-gray-400 space-y-1 list-decimal list-inside">
|
||||
<li>Tap the menu (⋮) button</li>
|
||||
<li>Tap "Add to Home screen" or "Install app"</li>
|
||||
<li>Tap "Install" to confirm</li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</UCard>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- PWA Features -->
|
||||
<div>
|
||||
<h3 class="text-lg font-semibold mb-3">App Features</h3>
|
||||
<div class="space-y-2">
|
||||
<div class="flex items-center gap-2 text-gray-700 dark:text-gray-300">
|
||||
<UIcon name="i-heroicons-check" class="w-5 h-5 text-emerald-500" />
|
||||
<span>Works offline with cached data</span>
|
||||
</div>
|
||||
<div class="flex items-center gap-2 text-gray-700 dark:text-gray-300">
|
||||
<UIcon name="i-heroicons-check" class="w-5 h-5 text-emerald-500" />
|
||||
<span>Quick access from home screen</span>
|
||||
</div>
|
||||
<div class="flex items-center gap-2 text-gray-700 dark:text-gray-300">
|
||||
<UIcon name="i-heroicons-check" class="w-5 h-5 text-emerald-500" />
|
||||
<span>Full-screen experience</span>
|
||||
</div>
|
||||
<div class="flex items-center gap-2 text-gray-700 dark:text-gray-300">
|
||||
<UIcon name="i-heroicons-check" class="w-5 h-5 text-emerald-500" />
|
||||
<span>Automatic updates</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Storage Info -->
|
||||
<div v-if="storageInfo">
|
||||
<h3 class="text-lg font-semibold mb-3">Storage Usage</h3>
|
||||
<div class="space-y-2">
|
||||
<div class="flex justify-between text-sm">
|
||||
<span class="text-gray-600 dark:text-gray-400">Used</span>
|
||||
<span class="font-medium">{{ formatBytes(storageInfo.usage) }}</span>
|
||||
</div>
|
||||
<div class="flex justify-between text-sm">
|
||||
<span class="text-gray-600 dark:text-gray-400">Available</span>
|
||||
<span class="font-medium">{{ formatBytes(storageInfo.quota) }}</span>
|
||||
</div>
|
||||
<div class="w-full bg-gray-200 dark:bg-gray-700 rounded-full h-2">
|
||||
<div
|
||||
class="bg-emerald-500 h-2 rounded-full transition-all"
|
||||
:style="{ width: storagePercent + '%' }"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</UCard>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
const { canInstall, isInstalled, promptInstall } = usePWAInstall()
|
||||
const installing = ref(false)
|
||||
const storageInfo = ref<{ usage: number; quota: number } | null>(null)
|
||||
|
||||
const isStandalone = computed(() => {
|
||||
if (process.client) {
|
||||
return window.matchMedia('(display-mode: standalone)').matches
|
||||
}
|
||||
return false
|
||||
})
|
||||
|
||||
const storagePercent = computed(() => {
|
||||
if (!storageInfo.value) return 0
|
||||
return Math.round((storageInfo.value.usage / storageInfo.value.quota) * 100)
|
||||
})
|
||||
|
||||
async function install() {
|
||||
installing.value = true
|
||||
try {
|
||||
await promptInstall()
|
||||
} catch (error) {
|
||||
console.error('Install failed:', error)
|
||||
} finally {
|
||||
installing.value = false
|
||||
}
|
||||
}
|
||||
|
||||
function formatBytes(bytes: number): string {
|
||||
if (bytes === 0) return '0 Bytes'
|
||||
const k = 1024
|
||||
const sizes = ['Bytes', 'KB', 'MB', 'GB']
|
||||
const i = Math.floor(Math.log(bytes) / Math.log(k))
|
||||
return Math.round((bytes / Math.pow(k, i)) * 100) / 100 + ' ' + sizes[i]
|
||||
}
|
||||
|
||||
onMounted(async () => {
|
||||
// Get storage info
|
||||
if ('storage' in navigator && 'estimate' in navigator.storage) {
|
||||
try {
|
||||
const estimate = await navigator.storage.estimate()
|
||||
if (estimate.usage !== undefined && estimate.quota !== undefined) {
|
||||
storageInfo.value = {
|
||||
usage: estimate.usage,
|
||||
quota: estimate.quota
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('Failed to get storage estimate:', error)
|
||||
}
|
||||
}
|
||||
})
|
||||
</script>
|
||||
@@ -57,6 +57,21 @@
|
||||
/>
|
||||
</UFormGroup>
|
||||
|
||||
<!-- Low Stock Threshold -->
|
||||
<UFormGroup
|
||||
label="Low Stock Alert"
|
||||
hint="Optional - Alert when quantity falls below this"
|
||||
>
|
||||
<UInput
|
||||
v-model.number="form.low_stock_threshold"
|
||||
type="number"
|
||||
min="0"
|
||||
step="0.1"
|
||||
placeholder="e.g. 2"
|
||||
size="lg"
|
||||
/>
|
||||
</UFormGroup>
|
||||
|
||||
<!-- Notes -->
|
||||
<UFormGroup label="Notes" hint="Optional">
|
||||
<UTextarea
|
||||
@@ -121,6 +136,7 @@ const form = reactive({
|
||||
quantity: 1,
|
||||
unit_id: '',
|
||||
expiry_date: '',
|
||||
low_stock_threshold: null as number | null,
|
||||
notes: ''
|
||||
})
|
||||
|
||||
@@ -210,6 +226,7 @@ const handleSubmit = async () => {
|
||||
quantity: form.quantity,
|
||||
unit_id: form.unit_id,
|
||||
expiry_date: form.expiry_date || null,
|
||||
low_stock_threshold: form.low_stock_threshold,
|
||||
notes: form.notes.trim() || null
|
||||
})
|
||||
|
||||
|
||||
@@ -55,6 +55,21 @@
|
||||
/>
|
||||
</UFormGroup>
|
||||
|
||||
<!-- Low Stock Threshold -->
|
||||
<UFormGroup
|
||||
label="Low Stock Alert"
|
||||
hint="Optional - Alert when quantity falls below this"
|
||||
>
|
||||
<UInput
|
||||
v-model.number="form.low_stock_threshold"
|
||||
type="number"
|
||||
min="0"
|
||||
step="0.1"
|
||||
placeholder="e.g. 2"
|
||||
size="lg"
|
||||
/>
|
||||
</UFormGroup>
|
||||
|
||||
<!-- Notes -->
|
||||
<UFormGroup label="Notes" hint="Optional">
|
||||
<UTextarea
|
||||
@@ -112,6 +127,7 @@ const form = reactive({
|
||||
quantity: 1,
|
||||
unit_id: '',
|
||||
expiry_date: '',
|
||||
low_stock_threshold: null as number | null,
|
||||
notes: ''
|
||||
})
|
||||
|
||||
@@ -136,6 +152,7 @@ watch(() => props.item, (newItem) => {
|
||||
form.quantity = Number(newItem.quantity)
|
||||
form.unit_id = newItem.unit_id
|
||||
form.expiry_date = newItem.expiry_date || ''
|
||||
form.low_stock_threshold = newItem.low_stock_threshold || null
|
||||
form.notes = newItem.notes || ''
|
||||
isOpen.value = true
|
||||
}
|
||||
@@ -168,6 +185,7 @@ const handleSubmit = async () => {
|
||||
quantity: form.quantity,
|
||||
unit_id: form.unit_id,
|
||||
expiry_date: form.expiry_date || null,
|
||||
low_stock_threshold: form.low_stock_threshold,
|
||||
notes: form.notes.trim() || null
|
||||
})
|
||||
|
||||
|
||||
@@ -72,6 +72,18 @@
|
||||
{{ expiryText }}
|
||||
</UBadge>
|
||||
</div>
|
||||
|
||||
<!-- Low Stock Warning -->
|
||||
<div v-if="isLowStock" class="text-xs">
|
||||
<UBadge
|
||||
color="orange"
|
||||
variant="soft"
|
||||
class="w-full justify-center"
|
||||
>
|
||||
<UIcon name="i-heroicons-exclamation-triangle" class="mr-1" />
|
||||
Low stock ({{ item.quantity }}/{{ item.low_stock_threshold }})
|
||||
</UBadge>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Action Buttons -->
|
||||
@@ -145,4 +157,10 @@ const expiryText = computed(() => {
|
||||
if (daysUntilExpiry.value === 1) return 'Expires tomorrow'
|
||||
return `Expires in ${daysUntilExpiry.value} days`
|
||||
})
|
||||
|
||||
// Low stock detection
|
||||
const isLowStock = computed(() => {
|
||||
if (!props.item.low_stock_threshold) return false
|
||||
return Number(props.item.quantity) <= Number(props.item.low_stock_threshold)
|
||||
})
|
||||
</script>
|
||||
|
||||
47
app/composables/useOnlineStatus.ts
Normal file
@@ -0,0 +1,47 @@
|
||||
/**
|
||||
* Composable to track online/offline status
|
||||
*
|
||||
* Usage:
|
||||
* const { isOnline, wasOffline } = useOnlineStatus()
|
||||
*
|
||||
* watch(isOnline, (online) => {
|
||||
* if (online && wasOffline.value) {
|
||||
* // User came back online, sync data
|
||||
* }
|
||||
* })
|
||||
*/
|
||||
export function useOnlineStatus() {
|
||||
const isOnline = ref(true)
|
||||
const wasOffline = ref(false)
|
||||
|
||||
if (process.client) {
|
||||
// Initial state
|
||||
isOnline.value = navigator.onLine
|
||||
|
||||
// Listen for online/offline events
|
||||
const updateOnlineStatus = () => {
|
||||
const online = navigator.onLine
|
||||
|
||||
if (!online && isOnline.value) {
|
||||
// Just went offline
|
||||
wasOffline.value = true
|
||||
}
|
||||
|
||||
isOnline.value = online
|
||||
}
|
||||
|
||||
window.addEventListener('online', updateOnlineStatus)
|
||||
window.addEventListener('offline', updateOnlineStatus)
|
||||
|
||||
// Cleanup on unmount
|
||||
onUnmounted(() => {
|
||||
window.removeEventListener('online', updateOnlineStatus)
|
||||
window.removeEventListener('offline', updateOnlineStatus)
|
||||
})
|
||||
}
|
||||
|
||||
return {
|
||||
isOnline: readonly(isOnline),
|
||||
wasOffline: readonly(wasOffline)
|
||||
}
|
||||
}
|
||||
93
app/composables/usePWAInstall.ts
Normal file
@@ -0,0 +1,93 @@
|
||||
/**
|
||||
* Composable to handle PWA installation
|
||||
*
|
||||
* Usage:
|
||||
* const { canInstall, isInstalled, promptInstall, dismissInstall } = usePWAInstall()
|
||||
*/
|
||||
export function usePWAInstall() {
|
||||
const canInstall = ref(false)
|
||||
const isInstalled = ref(false)
|
||||
const deferredPrompt = ref<any>(null)
|
||||
|
||||
if (process.client) {
|
||||
// Check if already installed
|
||||
if (window.matchMedia('(display-mode: standalone)').matches) {
|
||||
isInstalled.value = true
|
||||
}
|
||||
|
||||
// Listen for beforeinstallprompt event
|
||||
window.addEventListener('beforeinstallprompt', (e) => {
|
||||
// Prevent the mini-infobar from appearing on mobile
|
||||
e.preventDefault()
|
||||
|
||||
// Stash the event so it can be triggered later
|
||||
deferredPrompt.value = e
|
||||
canInstall.value = true
|
||||
})
|
||||
|
||||
// Listen for appinstalled event
|
||||
window.addEventListener('appinstalled', () => {
|
||||
isInstalled.value = true
|
||||
canInstall.value = false
|
||||
deferredPrompt.value = null
|
||||
})
|
||||
}
|
||||
|
||||
async function promptInstall() {
|
||||
if (!deferredPrompt.value) {
|
||||
return { outcome: 'not-available' }
|
||||
}
|
||||
|
||||
// Show the install prompt
|
||||
deferredPrompt.value.prompt()
|
||||
|
||||
// Wait for the user to respond to the prompt
|
||||
const { outcome } = await deferredPrompt.value.userChoice
|
||||
|
||||
// Clear the deferredPrompt
|
||||
deferredPrompt.value = null
|
||||
|
||||
if (outcome === 'accepted') {
|
||||
canInstall.value = false
|
||||
}
|
||||
|
||||
return { outcome }
|
||||
}
|
||||
|
||||
function dismissInstall() {
|
||||
canInstall.value = false
|
||||
deferredPrompt.value = null
|
||||
|
||||
// Remember dismissal for 7 days
|
||||
if (process.client) {
|
||||
localStorage.setItem('pwa-install-dismissed', Date.now().toString())
|
||||
}
|
||||
}
|
||||
|
||||
function shouldShowPrompt() {
|
||||
if (!canInstall.value || isInstalled.value) {
|
||||
return false
|
||||
}
|
||||
|
||||
if (process.client) {
|
||||
const dismissed = localStorage.getItem('pwa-install-dismissed')
|
||||
if (dismissed) {
|
||||
const dismissedTime = parseInt(dismissed)
|
||||
const sevenDays = 7 * 24 * 60 * 60 * 1000
|
||||
if (Date.now() - dismissedTime < sevenDays) {
|
||||
return false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
return {
|
||||
canInstall: readonly(canInstall),
|
||||
isInstalled: readonly(isInstalled),
|
||||
promptInstall,
|
||||
dismissInstall,
|
||||
shouldShowPrompt
|
||||
}
|
||||
}
|
||||
@@ -5,7 +5,8 @@ export default defineNuxtConfig({
|
||||
|
||||
modules: [
|
||||
'@nuxt/ui',
|
||||
'@nuxt/fonts'
|
||||
'@nuxt/fonts',
|
||||
'@vite-pwa/nuxt'
|
||||
],
|
||||
|
||||
runtimeConfig: {
|
||||
@@ -17,5 +18,166 @@ export default defineNuxtConfig({
|
||||
|
||||
colorMode: {
|
||||
preference: 'light'
|
||||
},
|
||||
|
||||
pwa: {
|
||||
registerType: 'autoUpdate',
|
||||
manifest: {
|
||||
name: 'Pantry - Smart Inventory Manager',
|
||||
short_name: 'Pantry',
|
||||
description: 'Track your household pantry inventory with ease. Barcode scanning, smart organization, and multi-user support.',
|
||||
theme_color: '#10b981',
|
||||
background_color: '#ffffff',
|
||||
display: 'standalone',
|
||||
orientation: 'portrait',
|
||||
scope: '/',
|
||||
start_url: '/',
|
||||
categories: ['productivity', 'lifestyle'],
|
||||
icons: [
|
||||
{
|
||||
src: '/icon-192x192.png',
|
||||
sizes: '192x192',
|
||||
type: 'image/png',
|
||||
purpose: 'any'
|
||||
},
|
||||
{
|
||||
src: '/icon-512x512.png',
|
||||
sizes: '512x512',
|
||||
type: 'image/png',
|
||||
purpose: 'any'
|
||||
},
|
||||
{
|
||||
src: '/icon-192x192-maskable.png',
|
||||
sizes: '192x192',
|
||||
type: 'image/png',
|
||||
purpose: 'maskable'
|
||||
},
|
||||
{
|
||||
src: '/icon-512x512-maskable.png',
|
||||
sizes: '512x512',
|
||||
type: 'image/png',
|
||||
purpose: 'maskable'
|
||||
}
|
||||
],
|
||||
screenshots: [
|
||||
{
|
||||
src: '/screenshot-mobile.png',
|
||||
sizes: '390x844',
|
||||
type: 'image/png',
|
||||
form_factor: 'narrow',
|
||||
label: 'Pantry inventory view on mobile'
|
||||
},
|
||||
{
|
||||
src: '/screenshot-desktop.png',
|
||||
sizes: '1920x1080',
|
||||
type: 'image/png',
|
||||
form_factor: 'wide',
|
||||
label: 'Pantry inventory view on desktop'
|
||||
}
|
||||
]
|
||||
},
|
||||
workbox: {
|
||||
navigateFallback: '/offline',
|
||||
navigateFallbackDenylist: [/^\/api\//],
|
||||
globPatterns: ['**/*.{js,css,html,png,svg,ico,woff,woff2}'],
|
||||
cleanupOutdatedCaches: true,
|
||||
skipWaiting: true,
|
||||
clientsClaim: true,
|
||||
runtimeCaching: [
|
||||
// Supabase API - Network first with fallback
|
||||
{
|
||||
urlPattern: /^https:\/\/.*\.supabase\.co\/rest\/.*/i,
|
||||
handler: 'NetworkFirst',
|
||||
options: {
|
||||
cacheName: 'supabase-rest-api',
|
||||
networkTimeoutSeconds: 10,
|
||||
expiration: {
|
||||
maxEntries: 50,
|
||||
maxAgeSeconds: 60 * 60 // 1 hour
|
||||
},
|
||||
cacheableResponse: {
|
||||
statuses: [0, 200]
|
||||
}
|
||||
}
|
||||
},
|
||||
// Supabase Auth - Network only (don't cache auth)
|
||||
{
|
||||
urlPattern: /^https:\/\/.*\.supabase\.co\/auth\/.*/i,
|
||||
handler: 'NetworkOnly'
|
||||
},
|
||||
// Supabase Storage - Cache first for images
|
||||
{
|
||||
urlPattern: /^https:\/\/.*\.supabase\.co\/storage\/.*/i,
|
||||
handler: 'CacheFirst',
|
||||
options: {
|
||||
cacheName: 'supabase-storage',
|
||||
expiration: {
|
||||
maxEntries: 100,
|
||||
maxAgeSeconds: 60 * 60 * 24 * 7 // 1 week
|
||||
},
|
||||
cacheableResponse: {
|
||||
statuses: [0, 200]
|
||||
}
|
||||
}
|
||||
},
|
||||
// Open Food Facts API - Cache first with network fallback
|
||||
{
|
||||
urlPattern: /^https:\/\/world\.openfoodfacts\.org\/.*/i,
|
||||
handler: 'CacheFirst',
|
||||
options: {
|
||||
cacheName: 'openfoodfacts-api',
|
||||
expiration: {
|
||||
maxEntries: 200,
|
||||
maxAgeSeconds: 60 * 60 * 24 * 30 // 30 days
|
||||
},
|
||||
cacheableResponse: {
|
||||
statuses: [0, 200]
|
||||
}
|
||||
}
|
||||
},
|
||||
// External images - Cache first
|
||||
{
|
||||
urlPattern: /^https:\/\/images\.openfoodfacts\.org\/.*/i,
|
||||
handler: 'CacheFirst',
|
||||
options: {
|
||||
cacheName: 'product-images',
|
||||
expiration: {
|
||||
maxEntries: 100,
|
||||
maxAgeSeconds: 60 * 60 * 24 * 30 // 30 days
|
||||
},
|
||||
cacheableResponse: {
|
||||
statuses: [0, 200]
|
||||
}
|
||||
}
|
||||
},
|
||||
// Google Fonts - Cache first
|
||||
{
|
||||
urlPattern: /^https:\/\/fonts\.googleapis\.com\/.*/i,
|
||||
handler: 'CacheFirst',
|
||||
options: {
|
||||
cacheName: 'google-fonts-stylesheets',
|
||||
expiration: {
|
||||
maxEntries: 20,
|
||||
maxAgeSeconds: 60 * 60 * 24 * 365 // 1 year
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
urlPattern: /^https:\/\/fonts\.gstatic\.com\/.*/i,
|
||||
handler: 'CacheFirst',
|
||||
options: {
|
||||
cacheName: 'google-fonts-webfonts',
|
||||
expiration: {
|
||||
maxEntries: 30,
|
||||
maxAgeSeconds: 60 * 60 * 24 * 365 // 1 year
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
devOptions: {
|
||||
enabled: true,
|
||||
type: 'module'
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
18031
app/package-lock.json
generated
Normal file
@@ -7,7 +7,9 @@
|
||||
"dev": "nuxt dev",
|
||||
"generate": "nuxt generate",
|
||||
"preview": "nuxt preview",
|
||||
"postinstall": "nuxt prepare"
|
||||
"postinstall": "nuxt prepare",
|
||||
"generate:icons": "node scripts/generate-icons.js && node scripts/generate-screenshots.js",
|
||||
"verify:pwa": "node scripts/verify-pwa.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"@nuxt/fonts": "^0.13.0",
|
||||
@@ -19,6 +21,8 @@
|
||||
"vue-router": "^4.6.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@nuxtjs/tailwindcss": "^6.14.0"
|
||||
"@nuxtjs/tailwindcss": "^6.14.0",
|
||||
"@vite-pwa/nuxt": "^1.1.1",
|
||||
"sharp": "^0.34.5"
|
||||
}
|
||||
}
|
||||
|
||||
69
app/pages/offline.vue
Normal file
@@ -0,0 +1,69 @@
|
||||
<template>
|
||||
<div class="flex flex-col items-center justify-center min-h-screen p-8 text-center">
|
||||
<UIcon name="i-heroicons-wifi-slash" class="w-24 h-24 text-gray-400 mb-6" />
|
||||
|
||||
<h1 class="text-3xl font-bold text-gray-900 mb-4">
|
||||
You're Offline
|
||||
</h1>
|
||||
|
||||
<p class="text-gray-600 mb-8 max-w-md">
|
||||
No internet connection detected. Some features may be limited, but you can still:
|
||||
</p>
|
||||
|
||||
<div class="space-y-3 mb-8 text-left max-w-md">
|
||||
<div class="flex items-start gap-3">
|
||||
<UIcon name="i-heroicons-check-circle" class="w-6 h-6 text-emerald-500 mt-0.5" />
|
||||
<span class="text-gray-700">View cached inventory items</span>
|
||||
</div>
|
||||
<div class="flex items-start gap-3">
|
||||
<UIcon name="i-heroicons-check-circle" class="w-6 h-6 text-emerald-500 mt-0.5" />
|
||||
<span class="text-gray-700">Scan barcodes (will sync when online)</span>
|
||||
</div>
|
||||
<div class="flex items-start gap-3">
|
||||
<UIcon name="i-heroicons-check-circle" class="w-6 h-6 text-emerald-500 mt-0.5" />
|
||||
<span class="text-gray-700">Browse previously loaded data</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<UButton
|
||||
color="emerald"
|
||||
size="lg"
|
||||
@click="retry"
|
||||
:loading="retrying"
|
||||
>
|
||||
<template #leading>
|
||||
<UIcon name="i-heroicons-arrow-path" />
|
||||
</template>
|
||||
Try Again
|
||||
</UButton>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
const retrying = ref(false)
|
||||
|
||||
async function retry() {
|
||||
retrying.value = true
|
||||
|
||||
try {
|
||||
// Test if we're back online
|
||||
const response = await fetch('/api/health', { method: 'HEAD' })
|
||||
if (response.ok) {
|
||||
// We're online! Go back
|
||||
window.location.reload()
|
||||
}
|
||||
} catch (error) {
|
||||
// Still offline
|
||||
setTimeout(() => {
|
||||
retrying.value = false
|
||||
}, 1000)
|
||||
}
|
||||
}
|
||||
|
||||
// Auto-retry when online event fires
|
||||
if (typeof window !== 'undefined') {
|
||||
window.addEventListener('online', () => {
|
||||
window.location.reload()
|
||||
})
|
||||
}
|
||||
</script>
|
||||
@@ -18,6 +18,10 @@
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<template #app>
|
||||
<SettingsAppSettings />
|
||||
</template>
|
||||
|
||||
<template #about>
|
||||
<UCard class="mt-4">
|
||||
<div class="space-y-4">
|
||||
@@ -52,6 +56,11 @@ const tabs = [
|
||||
label: 'Tags',
|
||||
icon: 'i-heroicons-tag'
|
||||
},
|
||||
{
|
||||
key: 'app',
|
||||
label: 'App',
|
||||
icon: 'i-heroicons-device-phone-mobile'
|
||||
},
|
||||
{
|
||||
key: 'account',
|
||||
label: 'Account',
|
||||
|
||||
BIN
app/public/apple-touch-icon.png
Normal file
|
After Width: | Height: | Size: 8.0 KiB |
|
Before Width: | Height: | Size: 4.2 KiB After Width: | Height: | Size: 1.7 KiB |
BIN
app/public/icon-192x192-maskable.png
Normal file
|
After Width: | Height: | Size: 7.0 KiB |
BIN
app/public/icon-192x192.png
Normal file
|
After Width: | Height: | Size: 8.6 KiB |
BIN
app/public/icon-512x512-maskable.png
Normal file
|
After Width: | Height: | Size: 21 KiB |
BIN
app/public/icon-512x512.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
46
app/public/icon.svg
Normal file
@@ -0,0 +1,46 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="none">
|
||||
<!-- Background circle with emerald gradient -->
|
||||
<defs>
|
||||
<linearGradient id="grad" x1="0%" y1="0%" x2="100%" y2="100%">
|
||||
<stop offset="0%" style="stop-color:#10b981;stop-opacity:1" />
|
||||
<stop offset="100%" style="stop-color:#059669;stop-opacity:1" />
|
||||
</linearGradient>
|
||||
</defs>
|
||||
|
||||
<!-- Background -->
|
||||
<circle cx="256" cy="256" r="256" fill="url(#grad)"/>
|
||||
|
||||
<!-- Pantry shelves icon (simplified cabinet with items) -->
|
||||
<g transform="translate(106, 96)">
|
||||
<!-- Cabinet outline -->
|
||||
<rect x="0" y="0" width="300" height="320" rx="12" fill="none" stroke="white" stroke-width="8"/>
|
||||
|
||||
<!-- Top shelf -->
|
||||
<line x1="0" y1="80" x2="300" y2="80" stroke="white" stroke-width="6"/>
|
||||
|
||||
<!-- Middle shelf -->
|
||||
<line x1="0" y1="160" x2="300" y2="160" stroke="white" stroke-width="6"/>
|
||||
|
||||
<!-- Bottom shelf -->
|
||||
<line x1="0" y1="240" x2="300" y2="240" stroke="white" stroke-width="6"/>
|
||||
|
||||
<!-- Top shelf items - jars -->
|
||||
<circle cx="60" cy="40" r="25" fill="white" opacity="0.9"/>
|
||||
<circle cx="150" cy="40" r="25" fill="white" opacity="0.9"/>
|
||||
<circle cx="240" cy="40" r="25" fill="white" opacity="0.9"/>
|
||||
|
||||
<!-- Middle shelf items - boxes -->
|
||||
<rect x="35" y="105" width="50" height="40" rx="4" fill="white" opacity="0.9"/>
|
||||
<rect x="125" y="105" width="50" height="40" rx="4" fill="white" opacity="0.9"/>
|
||||
<rect x="215" y="105" width="50" height="40" rx="4" fill="white" opacity="0.9"/>
|
||||
|
||||
<!-- Bottom shelf items - cans -->
|
||||
<rect x="35" y="185" width="50" height="45" rx="6" fill="white" opacity="0.9"/>
|
||||
<rect x="125" y="185" width="50" height="45" rx="6" fill="white" opacity="0.9"/>
|
||||
<rect x="215" y="185" width="50" height="45" rx="6" fill="white" opacity="0.9"/>
|
||||
|
||||
<!-- Very bottom items - larger containers -->
|
||||
<rect x="45" y="260" width="70" height="50" rx="6" fill="white" opacity="0.9"/>
|
||||
<rect x="185" y="260" width="70" height="50" rx="6" fill="white" opacity="0.9"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 2.0 KiB |
BIN
app/public/screenshot-desktop.png
Normal file
|
After Width: | Height: | Size: 71 KiB |
BIN
app/public/screenshot-mobile.png
Normal file
|
After Width: | Height: | Size: 21 KiB |
70
app/scripts/generate-icons.js
Normal file
@@ -0,0 +1,70 @@
|
||||
#!/usr/bin/env node
|
||||
import { readFile, writeFile } from 'fs/promises';
|
||||
import { join, dirname } from 'path';
|
||||
import { fileURLToPath } from 'url';
|
||||
import sharp from 'sharp';
|
||||
|
||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
||||
const publicDir = join(__dirname, '..', 'public');
|
||||
const svgPath = join(publicDir, 'icon.svg');
|
||||
|
||||
const sizes = [
|
||||
{ size: 192, name: 'icon-192x192.png', maskable: false },
|
||||
{ size: 512, name: 'icon-512x512.png', maskable: false },
|
||||
{ size: 192, name: 'icon-192x192-maskable.png', maskable: true },
|
||||
{ size: 512, name: 'icon-512x512-maskable.png', maskable: true },
|
||||
];
|
||||
|
||||
async function generateIcons() {
|
||||
console.log('Reading SVG icon...');
|
||||
const svgBuffer = await readFile(svgPath);
|
||||
|
||||
for (const { size, name, maskable } of sizes) {
|
||||
console.log(`Generating ${name}...`);
|
||||
|
||||
let buffer;
|
||||
if (maskable) {
|
||||
// Maskable icons need safe zone padding (80% of icon in center)
|
||||
// Create a transparent canvas with padding
|
||||
const paddedSize = size;
|
||||
const iconSize = Math.floor(size * 0.8);
|
||||
const offset = Math.floor((paddedSize - iconSize) / 2);
|
||||
|
||||
// Resize SVG to icon size
|
||||
const iconBuffer = await sharp(svgBuffer)
|
||||
.resize(iconSize, iconSize)
|
||||
.png()
|
||||
.toBuffer();
|
||||
|
||||
// Create transparent background and composite
|
||||
buffer = await sharp({
|
||||
create: {
|
||||
width: paddedSize,
|
||||
height: paddedSize,
|
||||
channels: 4,
|
||||
background: { r: 0, g: 0, b: 0, alpha: 0 }
|
||||
}
|
||||
})
|
||||
.composite([{
|
||||
input: iconBuffer,
|
||||
top: offset,
|
||||
left: offset
|
||||
}])
|
||||
.png()
|
||||
.toBuffer();
|
||||
} else {
|
||||
// Regular icon - full size
|
||||
buffer = await sharp(svgBuffer)
|
||||
.resize(size, size)
|
||||
.png()
|
||||
.toBuffer();
|
||||
}
|
||||
|
||||
await writeFile(join(publicDir, name), buffer);
|
||||
console.log(`✓ ${name}`);
|
||||
}
|
||||
|
||||
console.log('\n✅ All icons generated successfully!');
|
||||
}
|
||||
|
||||
generateIcons().catch(console.error);
|
||||
124
app/scripts/generate-screenshots.js
Normal file
@@ -0,0 +1,124 @@
|
||||
#!/usr/bin/env node
|
||||
import { writeFile } from 'fs/promises';
|
||||
import { join, dirname } from 'path';
|
||||
import { fileURLToPath } from 'url';
|
||||
import sharp from 'sharp';
|
||||
|
||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
||||
const publicDir = join(__dirname, '..', 'public');
|
||||
|
||||
async function generateScreenshots() {
|
||||
// Mobile screenshot (390x844 - iPhone 12/13/14 size)
|
||||
console.log('Generating mobile screenshot placeholder...');
|
||||
const mobileBuffer = await sharp({
|
||||
create: {
|
||||
width: 390,
|
||||
height: 844,
|
||||
channels: 4,
|
||||
background: { r: 249, g: 250, b: 251, alpha: 1 } // Tailwind gray-50
|
||||
}
|
||||
})
|
||||
.composite([
|
||||
{
|
||||
input: Buffer.from(`
|
||||
<svg width="390" height="844">
|
||||
<!-- Header -->
|
||||
<rect width="390" height="64" fill="#10b981"/>
|
||||
<text x="195" y="42" font-family="Arial" font-size="20" fill="white" text-anchor="middle" font-weight="bold">Pantry</text>
|
||||
|
||||
<!-- Content area -->
|
||||
<text x="24" y="104" font-family="Arial" font-size="24" fill="#111827" font-weight="bold">My Pantry</text>
|
||||
|
||||
<!-- Item cards -->
|
||||
<rect x="16" y="130" width="358" height="80" rx="8" fill="white" stroke="#e5e7eb" stroke-width="1"/>
|
||||
<text x="32" y="160" font-family="Arial" font-size="16" fill="#111827" font-weight="600">Milk</text>
|
||||
<text x="32" y="185" font-family="Arial" font-size="14" fill="#6b7280">Fridge • 1L</text>
|
||||
|
||||
<rect x="16" y="226" width="358" height="80" rx="8" fill="white" stroke="#e5e7eb" stroke-width="1"/>
|
||||
<text x="32" y="256" font-family="Arial" font-size="16" fill="#111827" font-weight="600">Pasta</text>
|
||||
<text x="32" y="281" font-family="Arial" font-size="14" fill="#6b7280">Pantry • 500g</text>
|
||||
|
||||
<rect x="16" y="322" width="358" height="80" rx="8" fill="white" stroke="#e5e7eb" stroke-width="1"/>
|
||||
<text x="32" y="352" font-family="Arial" font-size="16" fill="#111827" font-weight="600">Tomato Sauce</text>
|
||||
<text x="32" y="377" font-family="Arial" font-size="14" fill="#6b7280">Pantry • 400ml</text>
|
||||
|
||||
<!-- Bottom navigation -->
|
||||
<rect y="780" width="390" height="64" fill="white" stroke="#e5e7eb" stroke-width="1"/>
|
||||
<text x="78" y="820" font-family="Arial" font-size="12" fill="#6b7280" text-anchor="middle">Home</text>
|
||||
<text x="195" y="820" font-family="Arial" font-size="12" fill="#10b981" text-anchor="middle">Scan</text>
|
||||
<text x="312" y="820" font-family="Arial" font-size="12" fill="#6b7280" text-anchor="middle">Settings</text>
|
||||
</svg>
|
||||
`),
|
||||
top: 0,
|
||||
left: 0
|
||||
}
|
||||
])
|
||||
.png()
|
||||
.toBuffer();
|
||||
|
||||
await writeFile(join(publicDir, 'screenshot-mobile.png'), mobileBuffer);
|
||||
console.log('✓ screenshot-mobile.png');
|
||||
|
||||
// Desktop screenshot (1920x1080)
|
||||
console.log('Generating desktop screenshot placeholder...');
|
||||
const desktopBuffer = await sharp({
|
||||
create: {
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
channels: 4,
|
||||
background: { r: 249, g: 250, b: 251, alpha: 1 } // Tailwind gray-50
|
||||
}
|
||||
})
|
||||
.composite([
|
||||
{
|
||||
input: Buffer.from(`
|
||||
<svg width="1920" height="1080">
|
||||
<!-- Header -->
|
||||
<rect width="1920" height="80" fill="#10b981"/>
|
||||
<text x="960" y="50" font-family="Arial" font-size="32" fill="white" text-anchor="middle" font-weight="bold">Pantry - Smart Inventory Manager</text>
|
||||
|
||||
<!-- Sidebar -->
|
||||
<rect x="0" y="80" width="280" height="1000" fill="white" stroke="#e5e7eb" stroke-width="1"/>
|
||||
<text x="32" y="130" font-family="Arial" font-size="18" fill="#10b981" font-weight="600">Dashboard</text>
|
||||
<text x="32" y="180" font-family="Arial" font-size="18" fill="#6b7280">Scan Item</text>
|
||||
<text x="32" y="230" font-family="Arial" font-size="18" fill="#6b7280">Settings</text>
|
||||
|
||||
<!-- Main content -->
|
||||
<text x="340" y="150" font-family="Arial" font-size="36" fill="#111827" font-weight="bold">My Pantry Items</text>
|
||||
|
||||
<!-- Grid of items -->
|
||||
<rect x="340" y="200" width="480" height="180" rx="12" fill="white" stroke="#e5e7eb" stroke-width="2"/>
|
||||
<text x="370" y="250" font-family="Arial" font-size="24" fill="#111827" font-weight="600">Milk</text>
|
||||
<text x="370" y="290" font-family="Arial" font-size="18" fill="#6b7280">Fridge • 1L • Expires in 5 days</text>
|
||||
|
||||
<rect x="860" y="200" width="480" height="180" rx="12" fill="white" stroke="#e5e7eb" stroke-width="2"/>
|
||||
<text x="890" y="250" font-family="Arial" font-size="24" fill="#111827" font-weight="600">Pasta</text>
|
||||
<text x="890" y="290" font-family="Arial" font-size="18" fill="#6b7280">Pantry • 500g</text>
|
||||
|
||||
<rect x="1380" y="200" width="480" height="180" rx="12" fill="white" stroke="#e5e7eb" stroke-width="2"/>
|
||||
<text x="1410" y="250" font-family="Arial" font-size="24" fill="#111827" font-weight="600">Tomato Sauce</text>
|
||||
<text x="1410" y="290" font-family="Arial" font-size="18" fill="#6b7280">Pantry • 400ml</text>
|
||||
|
||||
<rect x="340" y="420" width="480" height="180" rx="12" fill="white" stroke="#e5e7eb" stroke-width="2"/>
|
||||
<text x="370" y="470" font-family="Arial" font-size="24" fill="#111827" font-weight="600">Rice</text>
|
||||
<text x="370" y="510" font-family="Arial" font-size="18" fill="#6b7280">Pantry • 1kg</text>
|
||||
|
||||
<rect x="860" y="420" width="480" height="180" rx="12" fill="white" stroke="#e5e7eb" stroke-width="2"/>
|
||||
<text x="890" y="470" font-family="Arial" font-size="24" fill="#111827" font-weight="600">Olive Oil</text>
|
||||
<text x="890" y="510" font-family="Arial" font-size="18" fill="#6b7280">Pantry • 750ml</text>
|
||||
</svg>
|
||||
`),
|
||||
top: 0,
|
||||
left: 0
|
||||
}
|
||||
])
|
||||
.png()
|
||||
.toBuffer();
|
||||
|
||||
await writeFile(join(publicDir, 'screenshot-desktop.png'), desktopBuffer);
|
||||
console.log('✓ screenshot-desktop.png');
|
||||
|
||||
console.log('\n✅ All screenshots generated successfully!');
|
||||
}
|
||||
|
||||
generateScreenshots().catch(console.error);
|
||||
141
app/scripts/verify-pwa.js
Normal file
@@ -0,0 +1,141 @@
|
||||
#!/usr/bin/env node
|
||||
/**
|
||||
* Verify PWA Configuration
|
||||
*
|
||||
* Checks that all PWA assets and configuration are present and valid.
|
||||
*/
|
||||
import { readFile, access } from 'fs/promises';
|
||||
import { join, dirname } from 'path';
|
||||
import { fileURLToPath } from 'url';
|
||||
|
||||
const __dirname = dirname(fileURLToPath(import.meta.url));
|
||||
const publicDir = join(__dirname, '..', 'public');
|
||||
const configPath = join(__dirname, '..', 'nuxt.config.ts');
|
||||
|
||||
let errors = [];
|
||||
let warnings = [];
|
||||
|
||||
async function checkFileExists(path, description) {
|
||||
try {
|
||||
await access(path);
|
||||
console.log(`✓ ${description}`);
|
||||
return true;
|
||||
} catch {
|
||||
errors.push(`✗ ${description} - File not found: ${path}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async function verifyPWA() {
|
||||
console.log('🔍 Verifying PWA Configuration...\n');
|
||||
|
||||
// Check icons
|
||||
console.log('Icons:');
|
||||
await checkFileExists(join(publicDir, 'icon.svg'), 'Source icon (SVG)');
|
||||
await checkFileExists(join(publicDir, 'icon-192x192.png'), 'Icon 192x192');
|
||||
await checkFileExists(join(publicDir, 'icon-512x512.png'), 'Icon 512x512');
|
||||
await checkFileExists(join(publicDir, 'icon-192x192-maskable.png'), 'Maskable icon 192x192');
|
||||
await checkFileExists(join(publicDir, 'icon-512x512-maskable.png'), 'Maskable icon 512x512');
|
||||
await checkFileExists(join(publicDir, 'favicon.ico'), 'Favicon');
|
||||
await checkFileExists(join(publicDir, 'apple-touch-icon.png'), 'Apple touch icon');
|
||||
|
||||
// Check screenshots
|
||||
console.log('\nScreenshots:');
|
||||
await checkFileExists(join(publicDir, 'screenshot-mobile.png'), 'Mobile screenshot');
|
||||
await checkFileExists(join(publicDir, 'screenshot-desktop.png'), 'Desktop screenshot');
|
||||
|
||||
// Check Nuxt config
|
||||
console.log('\nConfiguration:');
|
||||
const configExists = await checkFileExists(configPath, 'Nuxt config file');
|
||||
|
||||
if (configExists) {
|
||||
const config = await readFile(configPath, 'utf-8');
|
||||
|
||||
// Check for required PWA configuration
|
||||
if (config.includes('@vite-pwa/nuxt')) {
|
||||
console.log('✓ @vite-pwa/nuxt module configured');
|
||||
} else {
|
||||
errors.push('✗ @vite-pwa/nuxt module not found in config');
|
||||
}
|
||||
|
||||
if (config.includes('registerType')) {
|
||||
console.log('✓ Service worker registration configured');
|
||||
} else {
|
||||
warnings.push('⚠ Service worker registration type not set');
|
||||
}
|
||||
|
||||
if (config.includes('manifest')) {
|
||||
console.log('✓ PWA manifest configured');
|
||||
} else {
|
||||
errors.push('✗ PWA manifest configuration missing');
|
||||
}
|
||||
|
||||
if (config.includes('workbox')) {
|
||||
console.log('✓ Workbox configured');
|
||||
} else {
|
||||
warnings.push('⚠ Workbox configuration missing');
|
||||
}
|
||||
|
||||
// Check for important manifest fields
|
||||
if (config.includes('theme_color')) {
|
||||
console.log('✓ Theme color configured');
|
||||
} else {
|
||||
warnings.push('⚠ Theme color not configured');
|
||||
}
|
||||
|
||||
if (config.includes('display')) {
|
||||
console.log('✓ Display mode configured');
|
||||
} else {
|
||||
warnings.push('⚠ Display mode not configured');
|
||||
}
|
||||
}
|
||||
|
||||
// Check composables
|
||||
console.log('\nComposables:');
|
||||
await checkFileExists(join(__dirname, '..', 'composables', 'usePWAInstall.ts'), 'usePWAInstall composable');
|
||||
await checkFileExists(join(__dirname, '..', 'composables', 'useOnlineStatus.ts'), 'useOnlineStatus composable');
|
||||
|
||||
// Check components
|
||||
console.log('\nComponents:');
|
||||
await checkFileExists(join(__dirname, '..', 'components', 'InstallPrompt.vue'), 'InstallPrompt component');
|
||||
await checkFileExists(join(__dirname, '..', 'components', 'OfflineBanner.vue'), 'OfflineBanner component');
|
||||
|
||||
// Check pages
|
||||
console.log('\nPages:');
|
||||
await checkFileExists(join(__dirname, '..', 'pages', 'offline.vue'), 'Offline fallback page');
|
||||
|
||||
// Print summary
|
||||
console.log('\n' + '='.repeat(60));
|
||||
|
||||
if (errors.length === 0 && warnings.length === 0) {
|
||||
console.log('✅ PWA configuration is valid!');
|
||||
console.log('\nNext steps:');
|
||||
console.log('1. Run `npm run dev` and test in browser');
|
||||
console.log('2. Check DevTools → Application → Manifest');
|
||||
console.log('3. Test offline functionality');
|
||||
console.log('4. Run Lighthouse PWA audit');
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (warnings.length > 0) {
|
||||
console.log('\n⚠️ Warnings:');
|
||||
warnings.forEach(w => console.log(w));
|
||||
}
|
||||
|
||||
if (errors.length > 0) {
|
||||
console.log('\n❌ Errors:');
|
||||
errors.forEach(e => console.log(e));
|
||||
console.log('\nPWA configuration is incomplete. Please fix the errors above.');
|
||||
return 1;
|
||||
}
|
||||
|
||||
console.log('\n✅ PWA configuration is mostly valid (with warnings).');
|
||||
return 0;
|
||||
}
|
||||
|
||||
verifyPWA()
|
||||
.then(code => process.exit(code))
|
||||
.catch(error => {
|
||||
console.error('\n❌ Verification failed:', error.message);
|
||||
process.exit(1);
|
||||
});
|
||||
12
app/server/api/health.get.ts
Normal file
@@ -0,0 +1,12 @@
|
||||
/**
|
||||
* Health check endpoint for container monitoring
|
||||
*
|
||||
* Returns 200 OK if the server is running
|
||||
*/
|
||||
export default defineEventHandler(() => {
|
||||
return {
|
||||
status: 'ok',
|
||||
timestamp: new Date().toISOString(),
|
||||
uptime: process.uptime()
|
||||
}
|
||||
})
|
||||
@@ -26,6 +26,8 @@ export interface Database {
|
||||
quantity: number
|
||||
unit_id: string
|
||||
expiry_date: string | null
|
||||
expires_at: string | null
|
||||
low_stock_threshold: number | null
|
||||
notes: string | null
|
||||
added_by: string
|
||||
created_at: string
|
||||
@@ -38,6 +40,8 @@ export interface Database {
|
||||
quantity: number
|
||||
unit_id: string
|
||||
expiry_date?: string | null
|
||||
expires_at?: string | null
|
||||
low_stock_threshold?: number | null
|
||||
notes?: string | null
|
||||
added_by: string
|
||||
created_at?: string
|
||||
@@ -50,6 +54,8 @@ export interface Database {
|
||||
quantity?: number
|
||||
unit_id?: string
|
||||
expiry_date?: string | null
|
||||
expires_at?: string | null
|
||||
low_stock_threshold?: number | null
|
||||
notes?: string | null
|
||||
added_by?: string
|
||||
created_at?: string
|
||||
|
||||
52
docker-compose.prod.yml
Normal file
@@ -0,0 +1,52 @@
|
||||
# Production Docker Compose for Pantry App
|
||||
#
|
||||
# This compose file only runs the Nuxt frontend.
|
||||
# Supabase should be hosted separately (managed service or self-hosted).
|
||||
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
app:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
image: pantry:latest
|
||||
container_name: pantry-app
|
||||
restart: unless-stopped
|
||||
|
||||
ports:
|
||||
- "3000:3000"
|
||||
|
||||
environment:
|
||||
# Supabase connection (REQUIRED - set these in .env.production)
|
||||
NUXT_PUBLIC_SUPABASE_URL: ${NUXT_PUBLIC_SUPABASE_URL}
|
||||
NUXT_PUBLIC_SUPABASE_ANON_KEY: ${NUXT_PUBLIC_SUPABASE_ANON_KEY}
|
||||
|
||||
# Server configuration
|
||||
NODE_ENV: production
|
||||
HOST: 0.0.0.0
|
||||
PORT: 3000
|
||||
|
||||
healthcheck:
|
||||
test: ["CMD", "node", "-e", "require('http').get('http://localhost:3000/api/health', (r) => {process.exit(r.statusCode === 200 ? 0 : 1)})"]
|
||||
interval: 30s
|
||||
timeout: 3s
|
||||
start_period: 40s
|
||||
retries: 3
|
||||
|
||||
networks:
|
||||
- pantry
|
||||
|
||||
# Resource limits (adjust based on your needs)
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
memory: 512M
|
||||
cpus: '1.0'
|
||||
reservations:
|
||||
memory: 256M
|
||||
cpus: '0.5'
|
||||
|
||||
networks:
|
||||
pantry:
|
||||
driver: bridge
|
||||
90
docker/README.md
Normal file
@@ -0,0 +1,90 @@
|
||||
# Docker Deployment
|
||||
|
||||
## Production Dockerfile
|
||||
|
||||
The production Dockerfile uses a multi-stage build for optimized image size and security.
|
||||
|
||||
### Build the image
|
||||
|
||||
```bash
|
||||
docker build -t pantry:latest -f Dockerfile .
|
||||
```
|
||||
|
||||
### Run the container
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name pantry \
|
||||
-p 3000:3000 \
|
||||
-e NUXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co \
|
||||
-e NUXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key \
|
||||
pantry:latest
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
||||
Required:
|
||||
- `NUXT_PUBLIC_SUPABASE_URL` - Your Supabase project URL
|
||||
- `NUXT_PUBLIC_SUPABASE_ANON_KEY` - Your Supabase anon/public key
|
||||
|
||||
Optional:
|
||||
- `PORT` - Port to listen on (default: 3000)
|
||||
- `HOST` - Host to bind to (default: 0.0.0.0)
|
||||
|
||||
### Health Check
|
||||
|
||||
The container includes a health check endpoint at `/api/health`
|
||||
|
||||
```bash
|
||||
curl http://localhost:3000/api/health
|
||||
```
|
||||
|
||||
Expected response:
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"timestamp": "2026-02-25T00:00:00.000Z",
|
||||
"uptime": 123.456
|
||||
}
|
||||
```
|
||||
|
||||
### Image Features
|
||||
|
||||
- **Multi-stage build**: Separate build and runtime stages
|
||||
- **Alpine Linux**: Minimal base image (~50MB base)
|
||||
- **Non-root user**: Runs as unprivileged user (nodejs:1001)
|
||||
- **dumb-init**: Proper signal handling and zombie reaping
|
||||
- **Health checks**: Built-in container health monitoring
|
||||
- **Production-optimized**: Only production dependencies included
|
||||
|
||||
### Image Size
|
||||
|
||||
Approximate sizes:
|
||||
- Base Alpine + Node.js: ~50MB
|
||||
- Dependencies: ~150MB
|
||||
- Built app: ~20MB
|
||||
- **Total**: ~220MB
|
||||
|
||||
### Security
|
||||
|
||||
- Runs as non-root user (nodejs)
|
||||
- No unnecessary packages
|
||||
- Minimal attack surface
|
||||
- Regular security updates via Alpine base
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
View logs:
|
||||
```bash
|
||||
docker logs pantry
|
||||
```
|
||||
|
||||
Interactive shell:
|
||||
```bash
|
||||
docker exec -it pantry sh
|
||||
```
|
||||
|
||||
Check health:
|
||||
```bash
|
||||
docker inspect --format='{{json .State.Health}}' pantry
|
||||
```
|
||||
376
docs/COOLIFY_DEPLOYMENT.md
Normal file
@@ -0,0 +1,376 @@
|
||||
# Coolify Deployment Guide
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Coolify instance running (self-hosted or cloud)
|
||||
- Gitea repository accessible to Coolify
|
||||
- Supabase project (cloud or self-hosted)
|
||||
- Domain name (optional, for production)
|
||||
|
||||
## Deployment Steps
|
||||
|
||||
### 1. Prepare Supabase
|
||||
|
||||
#### Option A: Supabase Cloud
|
||||
|
||||
1. Sign in to [supabase.com](https://supabase.com)
|
||||
2. Create new project (or use existing)
|
||||
3. Run migrations:
|
||||
- Go to SQL Editor
|
||||
- Copy/paste each file from `supabase/migrations/`
|
||||
- Run in order: 001_, 002_, 003_, etc.
|
||||
4. Get credentials:
|
||||
- Project Settings → API
|
||||
- Copy Project URL
|
||||
- Copy `anon` / `public` key
|
||||
|
||||
#### Option B: Self-Hosted Supabase
|
||||
|
||||
```bash
|
||||
cd supabase
|
||||
docker-compose up -d
|
||||
# Wait for services to start
|
||||
docker-compose ps
|
||||
```
|
||||
|
||||
Migrations run automatically from `supabase/migrations/` directory.
|
||||
|
||||
### 2. Add Resource in Coolify
|
||||
|
||||
1. Log in to Coolify
|
||||
2. Click "New Resource"
|
||||
3. Select "Docker Compose"
|
||||
4. Choose deployment source:
|
||||
- **Git Repository** (recommended)
|
||||
- Public Git Repository
|
||||
- Docker Image
|
||||
|
||||
### 3. Configure Git Repository
|
||||
|
||||
If using Git source:
|
||||
|
||||
1. **Repository URL:**
|
||||
```
|
||||
https://gitea.jeanlucmakiola.de/pantry-app/pantry.git
|
||||
```
|
||||
|
||||
2. **Branch:** `main` (or `develop` for staging)
|
||||
|
||||
3. **Docker Compose File:** `docker-compose.prod.yml`
|
||||
|
||||
4. **Build Path:** Leave empty (uses root)
|
||||
|
||||
### 4. Set Environment Variables
|
||||
|
||||
In Coolify → Environment Variables, add:
|
||||
|
||||
```bash
|
||||
# Required
|
||||
NUXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
|
||||
NUXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key-here
|
||||
|
||||
# Optional
|
||||
NODE_ENV=production
|
||||
HOST=0.0.0.0
|
||||
PORT=3000
|
||||
```
|
||||
|
||||
**Security Note:** Never commit `.env` files with real credentials!
|
||||
|
||||
### 5. Configure Domain (Optional)
|
||||
|
||||
1. In Coolify → Domains
|
||||
2. Add your domain: `pantry.yourdomain.com`
|
||||
3. Coolify auto-provisions SSL with Let's Encrypt
|
||||
4. DNS: Point A record to Coolify server IP
|
||||
|
||||
### 6. Deploy
|
||||
|
||||
1. Click "Deploy" button
|
||||
2. Watch build logs
|
||||
3. Wait for "Deployed successfully" message
|
||||
|
||||
Expected deploy time: 2-5 minutes
|
||||
|
||||
### 7. Verify Deployment
|
||||
|
||||
#### Health Check
|
||||
|
||||
```bash
|
||||
curl https://pantry.yourdomain.com/api/health
|
||||
```
|
||||
|
||||
Expected response:
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"timestamp": "2026-02-25T00:00:00.000Z",
|
||||
"uptime": 123.456
|
||||
}
|
||||
```
|
||||
|
||||
#### PWA Check
|
||||
|
||||
1. Visit app in browser
|
||||
2. Open DevTools → Application → Manifest
|
||||
3. Verify manifest loads
|
||||
4. Check Service Worker is registered
|
||||
|
||||
#### Functionality Test
|
||||
|
||||
- [ ] Homepage loads
|
||||
- [ ] Can sign up / sign in
|
||||
- [ ] Can view inventory
|
||||
- [ ] Can add item
|
||||
- [ ] PWA install prompt appears
|
||||
- [ ] Offline mode works
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Build Fails
|
||||
|
||||
**Check build logs in Coolify:**
|
||||
|
||||
Common issues:
|
||||
- Missing dependencies → Check package.json
|
||||
- npm/node version mismatch → Use Node 20 Alpine
|
||||
- Out of memory → Increase Coolify resource limits
|
||||
|
||||
### Container Won't Start
|
||||
|
||||
**Check runtime logs in Coolify:**
|
||||
|
||||
Common issues:
|
||||
- Missing environment variables
|
||||
- Port conflict (use 3000)
|
||||
- Supabase connection timeout
|
||||
|
||||
### Supabase Connection Error
|
||||
|
||||
1. Verify Supabase URL is correct (no trailing slash)
|
||||
2. Check anon key is valid
|
||||
3. Test Supabase API directly:
|
||||
```bash
|
||||
curl https://your-project.supabase.co/rest/v1/
|
||||
```
|
||||
4. Check Supabase RLS policies allow access
|
||||
|
||||
### SSL Certificate Issues
|
||||
|
||||
Coolify should auto-provision Let's Encrypt cert:
|
||||
- Ensure domain points to correct IP
|
||||
- Check DNS propagation (can take 48h)
|
||||
- Verify port 80/443 open on firewall
|
||||
|
||||
### App Loads but No Data
|
||||
|
||||
1. Check browser console for errors
|
||||
2. Verify Supabase connection in Network tab
|
||||
3. Check RLS policies in Supabase
|
||||
4. Verify migrations ran successfully
|
||||
|
||||
## Continuous Deployment
|
||||
|
||||
### Auto-Deploy on Push
|
||||
|
||||
1. In Coolify → Settings → Webhooks
|
||||
2. Copy webhook URL
|
||||
3. In Gitea → Repo → Settings → Webhooks
|
||||
4. Add webhook:
|
||||
- URL: [Coolify webhook URL]
|
||||
- Events: Push events
|
||||
- Branch: main (or develop)
|
||||
|
||||
Now every git push triggers auto-deployment!
|
||||
|
||||
### Manual Deploy
|
||||
|
||||
In Coolify interface:
|
||||
1. Click "Deploy Latest" button
|
||||
2. Or use Coolify API:
|
||||
```bash
|
||||
curl -X POST https://coolify.example.com/api/deploy/[resource-id] \
|
||||
-H "Authorization: Bearer [your-token]"
|
||||
```
|
||||
|
||||
## Monitoring
|
||||
|
||||
### View Logs
|
||||
|
||||
Coolify Dashboard → Logs tab
|
||||
|
||||
Real-time logs:
|
||||
```bash
|
||||
# If SSH access to Coolify host
|
||||
docker logs -f [container-name]
|
||||
```
|
||||
|
||||
### Resource Usage
|
||||
|
||||
Coolify shows:
|
||||
- CPU usage
|
||||
- Memory usage
|
||||
- Network traffic
|
||||
- Storage
|
||||
|
||||
### Uptime Monitoring
|
||||
|
||||
Recommended external services:
|
||||
- UptimeRobot (free tier)
|
||||
- BetterStack
|
||||
- Freshping
|
||||
|
||||
Monitor: `https://pantry.yourdomain.com/api/health`
|
||||
|
||||
## Rollback
|
||||
|
||||
### To Previous Version
|
||||
|
||||
1. In Coolify → Deployments
|
||||
2. Click on previous successful deployment
|
||||
3. Click "Redeploy"
|
||||
|
||||
### Using Git Tags
|
||||
|
||||
```bash
|
||||
# Tag current release
|
||||
git tag -a v0.1.0 -m "MVP Release"
|
||||
git push origin v0.1.0
|
||||
|
||||
# Rollback by changing branch in Coolify
|
||||
# Or deploy specific tag
|
||||
```
|
||||
|
||||
## Performance Optimization
|
||||
|
||||
### Resource Limits
|
||||
|
||||
In docker-compose.prod.yml:
|
||||
```yaml
|
||||
deploy:
|
||||
resources:
|
||||
limits:
|
||||
memory: 512M
|
||||
cpus: '1.0'
|
||||
```
|
||||
|
||||
Adjust based on traffic.
|
||||
|
||||
### CDN (Recommended)
|
||||
|
||||
1. Add domain to Cloudflare
|
||||
2. Set DNS proxy (orange cloud)
|
||||
3. Enable caching rules
|
||||
4. Set SSL to "Full (strict)"
|
||||
|
||||
**Result:** ~50% faster load times globally
|
||||
|
||||
### Database Connection Pooling
|
||||
|
||||
If self-hosting Supabase:
|
||||
- Use PgBouncer (included in Supabase)
|
||||
- Set max connections: 20-50
|
||||
|
||||
## Security Checklist
|
||||
|
||||
Before going live:
|
||||
|
||||
- [ ] HTTPS enabled (automatic with Coolify)
|
||||
- [ ] Environment variables set (not in repo)
|
||||
- [ ] Supabase RLS policies enabled
|
||||
- [ ] Strong database passwords
|
||||
- [ ] Firewall configured (only 80/443 open)
|
||||
- [ ] Supabase auth configured
|
||||
- [ ] Regular backups enabled
|
||||
- [ ] Monitoring alerts set up
|
||||
|
||||
## Backup Strategy
|
||||
|
||||
### Database Backups
|
||||
|
||||
**Supabase Cloud:** Automatic daily backups
|
||||
|
||||
**Self-hosted:**
|
||||
```bash
|
||||
# Manual backup
|
||||
docker exec supabase-db pg_dump -U postgres > backup.sql
|
||||
|
||||
# Automated (cron)
|
||||
0 2 * * * /path/to/backup-script.sh
|
||||
```
|
||||
|
||||
### Volume Backups
|
||||
|
||||
Coolify persistent volumes:
|
||||
```bash
|
||||
docker run --rm \
|
||||
-v coolify_pantry_data:/data \
|
||||
-v $(pwd):/backup \
|
||||
ubuntu tar czf /backup/pantry-backup.tar.gz /data
|
||||
```
|
||||
|
||||
## Staging Environment
|
||||
|
||||
Recommended setup:
|
||||
|
||||
**Production:**
|
||||
- Branch: `main`
|
||||
- Domain: `pantry.yourdomain.com`
|
||||
- Supabase: Production project
|
||||
|
||||
**Staging:**
|
||||
- Branch: `develop`
|
||||
- Domain: `staging.pantry.yourdomain.com`
|
||||
- Supabase: Separate test project
|
||||
|
||||
In Coolify, create two resources pointing to different branches.
|
||||
|
||||
## Cost Estimate
|
||||
|
||||
**Coolify (self-hosted):**
|
||||
- VPS: $5-10/month (Hetzner, Digital Ocean)
|
||||
- Domain: $10-15/year
|
||||
- **Total:** ~$8/month
|
||||
|
||||
**Supabase Cloud:**
|
||||
- Free tier: 500MB database, 1GB file storage
|
||||
- Pro tier: $25/month (more resources)
|
||||
|
||||
**Total Cost:** $8-33/month for full stack
|
||||
|
||||
## Support
|
||||
|
||||
**Coolify:**
|
||||
- Docs: https://coolify.io/docs
|
||||
- Discord: https://discord.gg/coolify
|
||||
|
||||
**Pantry:**
|
||||
- Issues: https://gitea.jeanlucmakiola.de/pantry-app/pantry/issues
|
||||
- Discussions: TBD
|
||||
|
||||
## Post-Deployment Checklist
|
||||
|
||||
After first deployment:
|
||||
|
||||
- [ ] Health check passes
|
||||
- [ ] Can access homepage
|
||||
- [ ] Can sign up / sign in
|
||||
- [ ] Can add inventory item
|
||||
- [ ] PWA installs correctly
|
||||
- [ ] Offline mode works
|
||||
- [ ] SSL certificate valid
|
||||
- [ ] Monitoring alerts configured
|
||||
- [ ] Backup strategy in place
|
||||
- [ ] Team notified of URL
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Run E2E tests (see E2E_TESTING.md)
|
||||
2. Monitor for 24-48 hours
|
||||
3. Announce to users
|
||||
4. Set up analytics (optional)
|
||||
5. Plan first iteration
|
||||
|
||||
---
|
||||
|
||||
**Congratulations! Your app is live! 🎉**
|
||||
210
docs/DEPLOYMENT_CHECKLIST.md
Normal file
@@ -0,0 +1,210 @@
|
||||
# Deployment Checklist
|
||||
|
||||
Use this checklist to ensure a smooth deployment to production or staging.
|
||||
|
||||
## Pre-Deployment
|
||||
|
||||
### Code Quality
|
||||
- [ ] All tests passing (E2E_TESTING.md)
|
||||
- [ ] No critical bugs open
|
||||
- [ ] Code reviewed and approved
|
||||
- [ ] CHANGELOG.md updated
|
||||
- [ ] Version tagged in git
|
||||
|
||||
### Database
|
||||
- [ ] Migrations tested locally
|
||||
- [ ] Migrations run on staging
|
||||
- [ ] Seed data prepared (if needed)
|
||||
- [ ] Backup created
|
||||
- [ ] RLS policies verified
|
||||
|
||||
### Configuration
|
||||
- [ ] Environment variables documented
|
||||
- [ ] .env.production.example updated
|
||||
- [ ] Secrets not in repository
|
||||
- [ ] Docker files tested locally
|
||||
- [ ] Health check endpoint working
|
||||
|
||||
### Documentation
|
||||
- [ ] DEPLOYMENT.md reviewed
|
||||
- [ ] README.md up to date
|
||||
- [ ] API changes documented
|
||||
- [ ] Known issues documented
|
||||
|
||||
## Deployment
|
||||
|
||||
### Coolify Setup
|
||||
- [ ] Resource created in Coolify
|
||||
- [ ] Git repository connected
|
||||
- [ ] Branch configured (main/develop)
|
||||
- [ ] docker-compose.prod.yml path set
|
||||
- [ ] Environment variables added
|
||||
- [ ] Domain configured (optional)
|
||||
- [ ] SSL enabled
|
||||
|
||||
### Supabase Setup
|
||||
- [ ] Project created
|
||||
- [ ] Migrations run
|
||||
- [ ] RLS policies enabled
|
||||
- [ ] Auth providers configured
|
||||
- [ ] Storage buckets created
|
||||
- [ ] API keys copied
|
||||
|
||||
### Build & Deploy
|
||||
- [ ] Triggered deployment
|
||||
- [ ] Build logs checked (no errors)
|
||||
- [ ] Container started successfully
|
||||
- [ ] Health check passes
|
||||
|
||||
## Post-Deployment Verification
|
||||
|
||||
### Health Checks
|
||||
- [ ] `/api/health` returns 200 OK
|
||||
- [ ] Homepage loads
|
||||
- [ ] Auth works (sign up/in)
|
||||
- [ ] Database connection works
|
||||
|
||||
### PWA
|
||||
- [ ] Manifest loads correctly
|
||||
- [ ] Service worker registers
|
||||
- [ ] Install prompt appears
|
||||
- [ ] Offline mode works
|
||||
- [ ] Icons display correctly
|
||||
|
||||
### Functionality
|
||||
- [ ] Can create account
|
||||
- [ ] Can sign in
|
||||
- [ ] Can add inventory item
|
||||
- [ ] Can edit item
|
||||
- [ ] Can delete item
|
||||
- [ ] Can add tags
|
||||
- [ ] Can scan barcode (if implemented)
|
||||
|
||||
### Performance
|
||||
- [ ] Page load < 3s
|
||||
- [ ] Lighthouse score > 90 (PWA)
|
||||
- [ ] No console errors
|
||||
- [ ] No network errors
|
||||
|
||||
### Cross-Browser
|
||||
- [ ] Chrome (desktop)
|
||||
- [ ] Firefox (desktop)
|
||||
- [ ] Safari (desktop)
|
||||
- [ ] Chrome (mobile)
|
||||
- [ ] Safari (iOS)
|
||||
|
||||
## Monitoring
|
||||
|
||||
### Setup
|
||||
- [ ] Uptime monitoring configured
|
||||
- [ ] Error tracking enabled (optional)
|
||||
- [ ] Log aggregation set up
|
||||
- [ ] Alerts configured
|
||||
- [ ] Metrics dashboard created (optional)
|
||||
|
||||
### Checks
|
||||
- [ ] CPU usage normal
|
||||
- [ ] Memory usage normal
|
||||
- [ ] Disk space sufficient
|
||||
- [ ] No error spikes
|
||||
|
||||
## Security
|
||||
|
||||
### Verification
|
||||
- [ ] HTTPS enabled
|
||||
- [ ] SSL certificate valid
|
||||
- [ ] No credentials exposed
|
||||
- [ ] Firewall configured
|
||||
- [ ] Supabase RLS enabled
|
||||
- [ ] Strong admin passwords
|
||||
|
||||
### Compliance
|
||||
- [ ] Privacy policy added (if required)
|
||||
- [ ] Terms of service added (if required)
|
||||
- [ ] Cookie notice (if applicable)
|
||||
- [ ] GDPR compliance (if EU users)
|
||||
|
||||
## Communication
|
||||
|
||||
### Team
|
||||
- [ ] Deployment announced
|
||||
- [ ] Access details shared
|
||||
- [ ] Rollback plan communicated
|
||||
- [ ] Support plan established
|
||||
|
||||
### Users
|
||||
- [ ] Announcement prepared
|
||||
- [ ] Migration guide ready (if needed)
|
||||
- [ ] Support channels available
|
||||
- [ ] Feedback mechanism in place
|
||||
|
||||
## Backup & Recovery
|
||||
|
||||
### Backups
|
||||
- [ ] Database backup verified
|
||||
- [ ] Volume backup taken
|
||||
- [ ] Backup restore tested
|
||||
- [ ] Backup schedule configured
|
||||
|
||||
### Disaster Recovery
|
||||
- [ ] Rollback plan documented
|
||||
- [ ] Emergency contacts listed
|
||||
- [ ] Recovery time objective (RTO) defined
|
||||
- [ ] Recovery point objective (RPO) defined
|
||||
|
||||
## Post-Launch (24-48h)
|
||||
|
||||
### Monitoring
|
||||
- [ ] Check logs for errors
|
||||
- [ ] Review uptime metrics
|
||||
- [ ] Analyze user behavior
|
||||
- [ ] Check resource usage
|
||||
|
||||
### Optimization
|
||||
- [ ] Identify slow queries
|
||||
- [ ] Optimize heavy assets
|
||||
- [ ] Review caching strategy
|
||||
- [ ] Tune resource limits
|
||||
|
||||
### Feedback
|
||||
- [ ] Collect user feedback
|
||||
- [ ] Log issues found
|
||||
- [ ] Prioritize fixes
|
||||
- [ ] Plan next iteration
|
||||
|
||||
## Sign-Off
|
||||
|
||||
**Deployed by:** ___________________
|
||||
**Date:** ___________________
|
||||
**Environment:** Production / Staging
|
||||
**Version:** ___________________
|
||||
**Status:** ✅ Success / ⚠️ Issues / ❌ Failed
|
||||
|
||||
**Notes:**
|
||||
_____________________________________________
|
||||
_____________________________________________
|
||||
_____________________________________________
|
||||
|
||||
**Next Review:** ___________________
|
||||
|
||||
---
|
||||
|
||||
## Rollback Criteria
|
||||
|
||||
Trigger rollback if:
|
||||
- [ ] Critical bug discovered
|
||||
- [ ] Data loss occurring
|
||||
- [ ] Service unavailable > 15 min
|
||||
- [ ] Security vulnerability found
|
||||
- [ ] Performance degraded > 50%
|
||||
|
||||
**Rollback Procedure:**
|
||||
1. In Coolify → Previous deployment → Redeploy
|
||||
2. Or: `git revert` and redeploy
|
||||
3. Notify team and users
|
||||
4. Investigate root cause
|
||||
5. Fix and redeploy
|
||||
|
||||
---
|
||||
|
||||
**Remember:** It's better to delay than to deploy broken code. Take your time with this checklist!
|
||||
526
docs/E2E_TESTING.md
Normal file
@@ -0,0 +1,526 @@
|
||||
# End-to-End Testing Guide
|
||||
|
||||
## Overview
|
||||
|
||||
This guide covers manual end-to-end testing of the Pantry MVP. These tests ensure all critical user flows work correctly before release.
|
||||
|
||||
## Test Environment
|
||||
|
||||
**Requirements:**
|
||||
- Browser: Chrome/Edge, Firefox, or Safari
|
||||
- Resolution: 1920x1080 (desktop) and 390x844 (mobile)
|
||||
- Network: Both online and offline modes
|
||||
- Data: Fresh database with seed data
|
||||
|
||||
## Critical User Flows
|
||||
|
||||
### 1. Authentication Flow
|
||||
|
||||
#### Test 1.1: Sign Up
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Navigate to app home page
|
||||
2. Click "Sign Up" or similar
|
||||
3. Enter email: test@example.com
|
||||
4. Enter password: SecurePass123!
|
||||
5. Confirm password
|
||||
6. Submit form
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Validation errors if password too weak
|
||||
- ✅ Account created successfully
|
||||
- ✅ Redirected to home/dashboard
|
||||
- ✅ Welcome message shown (optional)
|
||||
|
||||
#### Test 1.2: Sign In
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Sign out if signed in
|
||||
2. Navigate to home page
|
||||
3. Click "Sign In"
|
||||
4. Enter correct credentials
|
||||
5. Submit form
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Successfully signed in
|
||||
- ✅ Redirected to dashboard
|
||||
- ✅ User menu shows email/name
|
||||
|
||||
#### Test 1.3: Sign In (Wrong Credentials)
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Try signing in with wrong password
|
||||
2. Try signing in with non-existent email
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Error message shown
|
||||
- ✅ Form not cleared (email retained)
|
||||
- ✅ No redirect
|
||||
- ✅ Try again allowed
|
||||
|
||||
#### Test 1.4: Sign Out
|
||||
**Priority:** HIGH
|
||||
|
||||
1. While signed in, click user menu
|
||||
2. Click "Sign Out"
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Signed out successfully
|
||||
- ✅ Redirected to sign-in page
|
||||
- ✅ Cannot access protected pages
|
||||
|
||||
### 2. Inventory Management
|
||||
|
||||
#### Test 2.1: View Inventory List
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Sign in
|
||||
2. Navigate to home/inventory page
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ List of pantry items displayed
|
||||
- ✅ Items show: name, quantity, unit, location tags
|
||||
- ✅ Empty state if no items
|
||||
- ✅ Loading state while fetching
|
||||
|
||||
#### Test 2.2: Add Item Manually
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Navigate to inventory
|
||||
2. Click "Add Item" button
|
||||
3. Enter item details:
|
||||
- Name: "Olive Oil"
|
||||
- Quantity: 1
|
||||
- Unit: L (liter)
|
||||
- Tags: pantry, cooking-oil
|
||||
4. Submit
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Form validation works
|
||||
- ✅ Item appears in list immediately
|
||||
- ✅ Success message shown
|
||||
- ✅ Form cleared for next entry
|
||||
|
||||
#### Test 2.3: Edit Item
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Click on an existing item
|
||||
2. Click "Edit" button
|
||||
3. Change quantity from 1 to 0.5
|
||||
4. Save changes
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Modal/form opens with current values
|
||||
- ✅ Changes saved successfully
|
||||
- ✅ List updated immediately
|
||||
- ✅ No page reload needed
|
||||
|
||||
#### Test 2.4: Delete Item
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Click on an item
|
||||
2. Click "Delete" button
|
||||
3. Confirm deletion
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Confirmation dialog shown
|
||||
- ✅ Item removed from list
|
||||
- ✅ Success message shown
|
||||
- ✅ Can undo (optional)
|
||||
|
||||
#### Test 2.5: Filter by Tag
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. View inventory list
|
||||
2. Click on a tag filter (e.g., "fridge")
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Only items with that tag shown
|
||||
- ✅ Filter state persists
|
||||
- ✅ Clear filter button available
|
||||
- ✅ Item count updated
|
||||
|
||||
### 3. Barcode Scanning
|
||||
|
||||
#### Test 3.1: Scan Known Product
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Navigate to Scan page
|
||||
2. Allow camera permissions
|
||||
3. Scan a barcode (e.g., Coca-Cola)
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Camera opens
|
||||
- ✅ Barcode detected
|
||||
- ✅ Product info fetched from Open Food Facts
|
||||
- ✅ Pre-filled add form shown
|
||||
- ✅ Can edit before adding
|
||||
|
||||
#### Test 3.2: Scan Unknown Product
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Scan a barcode not in database
|
||||
2. Manual entry form shown
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ "Product not found" message
|
||||
- ✅ Option to add manually
|
||||
- ✅ Barcode pre-filled
|
||||
- ✅ Can still save item
|
||||
|
||||
#### Test 3.3: Camera Permission Denied
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Block camera permission
|
||||
2. Try to scan
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Permission prompt shown
|
||||
- ✅ Helpful error message
|
||||
- ✅ Instructions to enable camera
|
||||
- ✅ Option to add manually
|
||||
|
||||
### 4. Tag Management
|
||||
|
||||
#### Test 4.1: Create Tag
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Go to Settings → Tags
|
||||
2. Click "Add Tag"
|
||||
3. Enter name: "freezer"
|
||||
4. Pick color: blue
|
||||
5. Save
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Tag created successfully
|
||||
- ✅ Appears in tag list
|
||||
- ✅ Available in item forms
|
||||
- ✅ Color applied correctly
|
||||
|
||||
#### Test 4.2: Edit Tag
|
||||
**Priority:** LOW
|
||||
|
||||
1. Click on existing tag
|
||||
2. Change name or color
|
||||
3. Save
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Tag updated
|
||||
- ✅ All items with tag reflect changes
|
||||
- ✅ No broken references
|
||||
|
||||
#### Test 4.3: Delete Tag
|
||||
**Priority:** LOW
|
||||
|
||||
1. Click delete on a tag
|
||||
2. Confirm
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Confirmation shown if tag in use
|
||||
- ✅ Tag removed
|
||||
- ✅ Items keep other tags
|
||||
- ✅ No app crashes
|
||||
|
||||
### 5. PWA Installation
|
||||
|
||||
#### Test 5.1: Install Prompt (Desktop)
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Visit app on Chrome (desktop)
|
||||
2. Wait 3 seconds
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Install banner appears
|
||||
- ✅ Shows app icon and name
|
||||
- ✅ Install button works
|
||||
- ✅ Can dismiss and won't show for 7 days
|
||||
|
||||
#### Test 5.2: Install from Settings
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Go to Settings → App
|
||||
2. Click "Install App" button
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Browser install dialog opens
|
||||
- ✅ App installs to desktop/home screen
|
||||
- ✅ Launches in standalone mode
|
||||
- ✅ Icon and name correct
|
||||
|
||||
#### Test 5.3: iOS Safari Add to Home Screen
|
||||
**Priority:** HIGH (iOS users)
|
||||
|
||||
1. Open app in Safari (iOS)
|
||||
2. Tap Share button
|
||||
3. Tap "Add to Home Screen"
|
||||
4. Confirm
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Icon added to home screen
|
||||
- ✅ Opens in standalone mode
|
||||
- ✅ Splash screen shown
|
||||
- ✅ No Safari UI
|
||||
|
||||
### 6. Offline Functionality
|
||||
|
||||
#### Test 6.1: Work Offline
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Load app while online
|
||||
2. Navigate to all pages
|
||||
3. Disconnect internet
|
||||
4. Try navigating again
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Offline banner appears
|
||||
- ✅ Previously visited pages load
|
||||
- ✅ Cached data visible
|
||||
- ✅ No white screens or errors
|
||||
|
||||
#### Test 6.2: Offline Indicator
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Go offline
|
||||
2. Check for visual feedback
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ "You're offline" banner at top
|
||||
- ✅ Banner is amber/warning color
|
||||
- ✅ Icon indicates offline status
|
||||
|
||||
#### Test 6.3: Return Online
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Go offline
|
||||
2. Wait a few seconds
|
||||
3. Go online
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ "Back online!" banner (green)
|
||||
- ✅ Auto-hides after 3 seconds
|
||||
- ✅ Data syncs (if pending changes)
|
||||
|
||||
### 7. Responsive Design
|
||||
|
||||
#### Test 7.1: Mobile View
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Resize browser to 390px wide
|
||||
2. Navigate all pages
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Navigation adapts (hamburger menu)
|
||||
- ✅ Lists stack vertically
|
||||
- ✅ Buttons are touch-friendly
|
||||
- ✅ No horizontal scroll
|
||||
- ✅ Text readable without zoom
|
||||
|
||||
#### Test 7.2: Tablet View
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Resize to 768px wide
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Layout adapts
|
||||
- ✅ 2-column grids where appropriate
|
||||
- ✅ Navigation hybrid or drawer
|
||||
|
||||
#### Test 7.3: Desktop View
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. View at 1920px wide
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Full navigation visible
|
||||
- ✅ Multi-column layouts
|
||||
- ✅ Content not stretched too wide
|
||||
- ✅ Whitespace used effectively
|
||||
|
||||
### 8. Performance
|
||||
|
||||
#### Test 8.1: Page Load Time
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Clear cache
|
||||
2. Load home page
|
||||
3. Measure time to interactive
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ < 3 seconds on 4G
|
||||
- ✅ < 1 second on repeat visit
|
||||
- ✅ Loading indicators shown
|
||||
|
||||
#### Test 8.2: Lighthouse Score
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Open DevTools → Lighthouse
|
||||
2. Run "Progressive Web App" audit
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ PWA score: 90+
|
||||
- ✅ Performance: 80+
|
||||
- ✅ Accessibility: 90+
|
||||
- ✅ Best Practices: 90+
|
||||
|
||||
### 9. Accessibility
|
||||
|
||||
#### Test 9.1: Keyboard Navigation
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Use only keyboard (Tab, Enter, Esc)
|
||||
2. Navigate entire app
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ All interactive elements reachable
|
||||
- ✅ Focus indicators visible
|
||||
- ✅ Modals can be closed with Esc
|
||||
- ✅ Logical tab order
|
||||
|
||||
#### Test 9.2: Screen Reader
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Enable VoiceOver (Mac) or NVDA (Windows)
|
||||
2. Navigate app
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ All text announced
|
||||
- ✅ Images have alt text
|
||||
- ✅ Form labels read correctly
|
||||
- ✅ Buttons have meaningful labels
|
||||
|
||||
### 10. Error Handling
|
||||
|
||||
#### Test 10.1: Network Error
|
||||
**Priority:** HIGH
|
||||
|
||||
1. Start action (add item)
|
||||
2. Disable network mid-request
|
||||
3. Check behavior
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Error message shown
|
||||
- ✅ Action can be retried
|
||||
- ✅ Data not lost
|
||||
- ✅ No crash
|
||||
|
||||
#### Test 10.2: Server Error (500)
|
||||
**Priority:** MEDIUM
|
||||
|
||||
1. Trigger server error (if possible)
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ User-friendly error message
|
||||
- ✅ No stack traces visible
|
||||
- ✅ Option to try again
|
||||
- ✅ Logs sent to monitoring (optional)
|
||||
|
||||
## Test Data Setup
|
||||
|
||||
### Seed Data Script
|
||||
|
||||
```sql
|
||||
-- Run in Supabase SQL Editor
|
||||
-- Insert test household
|
||||
INSERT INTO households (id, name) VALUES
|
||||
('test-household-1', 'Test Household');
|
||||
|
||||
-- Insert test tags
|
||||
INSERT INTO tags (id, household_id, name, color) VALUES
|
||||
('tag-1', 'test-household-1', 'fridge', '#3b82f6'),
|
||||
('tag-2', 'test-household-1', 'pantry', '#10b981'),
|
||||
('tag-3', 'test-household-1', 'freezer', '#6366f1');
|
||||
|
||||
-- Insert test units
|
||||
INSERT INTO units (id, household_id, name, abbreviation, base_unit, conversion_factor) VALUES
|
||||
('unit-1', 'test-household-1', 'liter', 'L', 'L', 1),
|
||||
('unit-2', 'test-household-1', 'milliliter', 'mL', 'L', 0.001),
|
||||
('unit-3', 'test-household-1', 'kilogram', 'kg', 'kg', 1);
|
||||
|
||||
-- Insert test items
|
||||
INSERT INTO pantry_items (household_id, name, quantity, unit_id) VALUES
|
||||
('test-household-1', 'Milk', 1, 'unit-1'),
|
||||
('test-household-1', 'Rice', 2, 'unit-3'),
|
||||
('test-household-1', 'Olive Oil', 0.5, 'unit-1');
|
||||
```
|
||||
|
||||
## Test Execution Checklist
|
||||
|
||||
**Before Testing:**
|
||||
- [ ] Fresh database with seed data
|
||||
- [ ] Clear browser cache
|
||||
- [ ] Clear localStorage
|
||||
- [ ] Unregister service workers
|
||||
- [ ] Sign out all accounts
|
||||
|
||||
**Test Environments:**
|
||||
- [ ] Chrome (Windows/Mac/Linux)
|
||||
- [ ] Firefox (Windows/Mac/Linux)
|
||||
- [ ] Safari (Mac/iOS)
|
||||
- [ ] Mobile Chrome (Android)
|
||||
- [ ] Mobile Safari (iOS)
|
||||
|
||||
**Test Scenarios:**
|
||||
- [ ] Authentication (4 tests)
|
||||
- [ ] Inventory Management (5 tests)
|
||||
- [ ] Barcode Scanning (3 tests)
|
||||
- [ ] Tag Management (3 tests)
|
||||
- [ ] PWA Installation (3 tests)
|
||||
- [ ] Offline Functionality (3 tests)
|
||||
- [ ] Responsive Design (3 tests)
|
||||
- [ ] Performance (2 tests)
|
||||
- [ ] Accessibility (2 tests)
|
||||
- [ ] Error Handling (2 tests)
|
||||
|
||||
## Bug Report Template
|
||||
|
||||
```
|
||||
**Title:** Short description
|
||||
|
||||
**Priority:** High / Medium / Low
|
||||
|
||||
**Environment:**
|
||||
- Browser: Chrome 120.0
|
||||
- OS: Windows 11
|
||||
- Device: Desktop 1920x1080
|
||||
|
||||
**Steps to Reproduce:**
|
||||
1. Navigate to...
|
||||
2. Click on...
|
||||
3. Enter...
|
||||
|
||||
**Expected Result:**
|
||||
What should happen
|
||||
|
||||
**Actual Result:**
|
||||
What actually happened
|
||||
|
||||
**Screenshots/Video:**
|
||||
[Attach if applicable]
|
||||
|
||||
**Console Errors:**
|
||||
[Copy any errors from DevTools console]
|
||||
|
||||
**Workaround:**
|
||||
[If known]
|
||||
```
|
||||
|
||||
## Sign-off
|
||||
|
||||
**Tested by:** [Name]
|
||||
**Date:** [Date]
|
||||
**Environment:** [Browser, OS]
|
||||
**Total Tests:** [X]
|
||||
**Passed:** [X]
|
||||
**Failed:** [X]
|
||||
**Blocked:** [X]
|
||||
|
||||
**Critical Issues Found:** [List or "None"]
|
||||
**Recommendation:** ✅ Ready for Release / ❌ Needs Fixes
|
||||
|
||||
---
|
||||
|
||||
**Next Steps:**
|
||||
- Fix critical issues
|
||||
- Retest failed scenarios
|
||||
- Document known limitations
|
||||
- Prepare release notes
|
||||
283
docs/PWA_TESTING.md
Normal file
@@ -0,0 +1,283 @@
|
||||
# PWA Offline Functionality Testing Guide
|
||||
|
||||
## Overview
|
||||
|
||||
This guide covers testing the Progressive Web App (PWA) features and offline functionality of Pantry.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Development server running (`npm run dev` in the `app/` directory)
|
||||
- Modern browser (Chrome, Edge, Safari, or Firefox)
|
||||
- Browser DevTools access
|
||||
|
||||
## Test Categories
|
||||
|
||||
### 1. PWA Manifest & Installation
|
||||
|
||||
#### Test 1.1: Manifest Validation
|
||||
1. Open browser DevTools → Application tab
|
||||
2. Navigate to "Manifest" section
|
||||
3. **Expected Results:**
|
||||
- ✅ Manifest loads without errors
|
||||
- ✅ App name: "Pantry - Smart Inventory Manager"
|
||||
- ✅ Short name: "Pantry"
|
||||
- ✅ Theme color: #10b981 (emerald)
|
||||
- ✅ All icons (192x192, 512x512, maskable) present
|
||||
- ✅ Display mode: standalone
|
||||
- ✅ No manifest warnings
|
||||
|
||||
#### Test 1.2: Install Prompt
|
||||
1. Wait 3 seconds after page load
|
||||
2. **Expected Results:**
|
||||
- ✅ Install prompt card appears (bottom-right on desktop, bottom on mobile)
|
||||
- ✅ Shows app icon and "Install Pantry" title
|
||||
- ✅ "Install" button is clickable
|
||||
- ✅ "Not now" dismisses the prompt
|
||||
- ✅ Close (X) button dismisses the prompt
|
||||
|
||||
#### Test 1.3: Manual Installation from Settings
|
||||
1. Navigate to Settings → App tab
|
||||
2. **Expected Results:**
|
||||
- ✅ Shows "Install App" button
|
||||
- ✅ Clicking installs the app
|
||||
- ✅ After install, shows "App is installed" status
|
||||
- ✅ Storage usage displayed with progress bar
|
||||
|
||||
#### Test 1.4: Platform-Specific Instructions
|
||||
1. View Settings → App tab on device without beforeinstallprompt support
|
||||
2. **Expected Results:**
|
||||
- ✅ Shows iOS installation instructions (if on iOS)
|
||||
- ✅ Shows Android installation instructions (if on Android)
|
||||
- ✅ Instructions are clear and accurate
|
||||
|
||||
### 2. Service Worker
|
||||
|
||||
#### Test 2.1: Service Worker Registration
|
||||
1. Open DevTools → Application → Service Workers
|
||||
2. **Expected Results:**
|
||||
- ✅ Service worker registered
|
||||
- ✅ Status: "activated and running"
|
||||
- ✅ No registration errors
|
||||
- ✅ Update on reload enabled
|
||||
|
||||
#### Test 2.2: Cache Storage
|
||||
1. Open DevTools → Application → Cache Storage
|
||||
2. Navigate through the app (Home, Scan, Settings)
|
||||
3. **Expected Results:**
|
||||
- ✅ Multiple cache buckets created:
|
||||
- workbox-precache (app shell)
|
||||
- supabase-rest-api
|
||||
- supabase-storage
|
||||
- product-images (if products viewed)
|
||||
- google-fonts-stylesheets
|
||||
- google-fonts-webfonts
|
||||
- ✅ App shell assets cached (JS, CSS, HTML)
|
||||
- ✅ Icons and images cached
|
||||
|
||||
#### Test 2.3: Update Behavior
|
||||
1. Make a code change
|
||||
2. Rebuild the app
|
||||
3. Refresh the page
|
||||
4. **Expected Results:**
|
||||
- ✅ Service worker updates in background
|
||||
- ✅ New version activates automatically (skipWaiting)
|
||||
- ✅ No manual refresh required for future visits
|
||||
|
||||
### 3. Offline Functionality
|
||||
|
||||
#### Test 3.1: Complete Offline Mode
|
||||
1. Load the app while online
|
||||
2. Navigate to all pages (Home, Scan, Settings)
|
||||
3. Open DevTools → Network tab
|
||||
4. Enable "Offline" mode
|
||||
5. Try navigating the app
|
||||
6. **Expected Results:**
|
||||
- ✅ App continues to function
|
||||
- ✅ Previously visited pages load instantly
|
||||
- ✅ Offline banner appears at top
|
||||
- ✅ Banner shows "You're currently offline" message
|
||||
- ✅ Navigation between cached pages works
|
||||
- ✅ No white screens or errors
|
||||
|
||||
#### Test 3.2: Offline Fallback Page
|
||||
1. Go offline (DevTools Network → Offline)
|
||||
2. Try navigating to a non-cached page (e.g., type random URL)
|
||||
3. **Expected Results:**
|
||||
- ✅ Redirects to /offline page
|
||||
- ✅ Shows WiFi icon and helpful message
|
||||
- ✅ Lists what you can do offline
|
||||
- ✅ "Try Again" button present
|
||||
- ✅ Auto-redirects when back online
|
||||
|
||||
#### Test 3.3: Online Status Detection
|
||||
1. Start online, go offline, come back online
|
||||
2. **Expected Results:**
|
||||
- ✅ Offline banner appears when offline
|
||||
- ✅ "Back online!" banner shows when reconnected (green)
|
||||
- ✅ Banner auto-hides after 3 seconds
|
||||
- ✅ No false positives
|
||||
|
||||
#### Test 3.4: API Request Caching (Supabase)
|
||||
1. While online, view some inventory items (once implemented)
|
||||
2. Go offline
|
||||
3. Navigate to the items page
|
||||
4. **Expected Results:**
|
||||
- ✅ Previously loaded items still visible
|
||||
- ✅ Network requests fail gracefully
|
||||
- ✅ Cached data is served
|
||||
- ✅ No crashes or white screens
|
||||
|
||||
#### Test 3.5: Image Caching (Product Images)
|
||||
1. While online, view products with images
|
||||
2. Go offline
|
||||
3. View the same products again
|
||||
4. **Expected Results:**
|
||||
- ✅ Product images load from cache
|
||||
- ✅ No broken image placeholders
|
||||
- ✅ Images from Open Food Facts cached
|
||||
|
||||
### 4. Background Sync (Future Enhancement)
|
||||
|
||||
**Note:** Background sync not yet implemented. This section is reserved for future testing.
|
||||
|
||||
### 5. Cross-Platform Testing
|
||||
|
||||
#### Test 5.1: Desktop Browsers
|
||||
Test on:
|
||||
- [ ] Chrome/Edge (Windows/Mac/Linux)
|
||||
- [ ] Firefox (Windows/Mac/Linux)
|
||||
- [ ] Safari (Mac only)
|
||||
|
||||
#### Test 5.2: Mobile Browsers
|
||||
Test on:
|
||||
- [ ] Chrome (Android)
|
||||
- [ ] Safari (iOS)
|
||||
- [ ] Firefox (Android)
|
||||
- [ ] Samsung Internet (Android)
|
||||
|
||||
#### Test 5.3: Installed App vs Browser
|
||||
Compare behavior when:
|
||||
- [ ] Running in browser tab
|
||||
- [ ] Running as installed PWA (standalone mode)
|
||||
|
||||
**Expected Results:**
|
||||
- ✅ Identical functionality
|
||||
- ✅ Installed app shows in app switcher
|
||||
- ✅ Installed app has no browser chrome
|
||||
- ✅ Installed app survives system restart
|
||||
|
||||
### 6. Performance Testing
|
||||
|
||||
#### Test 6.1: First Load Performance
|
||||
1. Clear all caches
|
||||
2. Load the app (online)
|
||||
3. Check DevTools → Lighthouse
|
||||
4. Run PWA audit
|
||||
5. **Expected Results:**
|
||||
- ✅ PWA score: 90+ / 100
|
||||
- ✅ Performance score: 80+ / 100
|
||||
- ✅ "Installable" badge present
|
||||
- ✅ No PWA warnings
|
||||
|
||||
#### Test 6.2: Repeat Visit Performance
|
||||
1. Visit the app
|
||||
2. Navigate around
|
||||
3. Close tab
|
||||
4. Reopen the app
|
||||
5. **Expected Results:**
|
||||
- ✅ Instant load from cache
|
||||
- ✅ No flash of white screen
|
||||
- ✅ Content visible immediately
|
||||
|
||||
### 7. Storage Management
|
||||
|
||||
#### Test 7.1: Storage Quota
|
||||
1. Open Settings → App tab
|
||||
2. **Expected Results:**
|
||||
- ✅ Storage usage displayed
|
||||
- ✅ Storage quota displayed
|
||||
- ✅ Usage percentage shown visually
|
||||
- ✅ Numbers update as cache grows
|
||||
|
||||
#### Test 7.2: Cache Eviction
|
||||
1. Fill cache with many images/data
|
||||
2. Exceed storage quota
|
||||
3. **Expected Results:**
|
||||
- ✅ Oldest cache entries evicted automatically
|
||||
- ✅ No app crashes
|
||||
- ✅ App continues to function
|
||||
|
||||
## Automated Testing (Future)
|
||||
|
||||
### Playwright E2E Tests (Planned)
|
||||
|
||||
```typescript
|
||||
// Example test structure
|
||||
test('PWA installs correctly', async ({ page }) => {
|
||||
// Test installation flow
|
||||
})
|
||||
|
||||
test('App works offline', async ({ page, context }) => {
|
||||
// Load app, go offline, verify functionality
|
||||
})
|
||||
```
|
||||
|
||||
## Known Issues & Limitations
|
||||
|
||||
1. **iOS Safari:**
|
||||
- No beforeinstallprompt event (use manual Add to Home Screen)
|
||||
- Service worker has storage limits
|
||||
- Background sync not supported
|
||||
|
||||
2. **Firefox:**
|
||||
- Install prompt may not show (desktop only)
|
||||
- Use "Add to Home Screen" on mobile
|
||||
|
||||
3. **Development Mode:**
|
||||
- Service worker may behave differently
|
||||
- Always test in production build
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Service Worker Not Updating
|
||||
- Hard refresh: Ctrl+Shift+R (Windows/Linux) or Cmd+Shift+R (Mac)
|
||||
- DevTools → Application → Service Workers → Unregister
|
||||
- Clear cache and reload
|
||||
|
||||
### Install Prompt Not Showing
|
||||
- Check if already installed
|
||||
- Check localStorage for `pwa-install-dismissed`
|
||||
- Wait 7 days or clear localStorage
|
||||
- Ensure criteria met (HTTPS, manifest, service worker)
|
||||
|
||||
### Offline Mode Not Working
|
||||
- Verify service worker is active
|
||||
- Check cache storage has content
|
||||
- Ensure you visited pages while online first
|
||||
|
||||
## Success Criteria
|
||||
|
||||
All tests must pass before marking issue #36 complete:
|
||||
|
||||
- [x] PWA manifest loads correctly
|
||||
- [x] Install prompt works
|
||||
- [x] Service worker registers and activates
|
||||
- [x] App works offline
|
||||
- [x] Cached content loads
|
||||
- [x] Offline banner shows/hides correctly
|
||||
- [x] Online status detected accurately
|
||||
- [x] Install instructions provided for unsupported browsers
|
||||
- [x] Storage usage displayed
|
||||
- [x] No console errors during offline usage
|
||||
|
||||
## Sign-off
|
||||
|
||||
**Tested by:** [Name]
|
||||
**Date:** [Date]
|
||||
**Browsers tested:** [List]
|
||||
**Issues found:** [List or "None"]
|
||||
**Status:** ✅ Pass / ❌ Fail
|
||||
|
||||
---
|
||||
|
||||
**Next Steps:** After testing passes, proceed to Week 6 (Deployment & Testing).
|
||||
26
supabase/migrations/006_add_expiry_lowstock.sql
Normal file
@@ -0,0 +1,26 @@
|
||||
-- Migration: Add expiry date and low-stock threshold tracking
|
||||
-- Issues: #63 (expiry tracking), #67 (low-stock threshold)
|
||||
-- Created: 2026-02-25
|
||||
|
||||
-- Note: expiry_date already exists as DATE type. Adding expires_at as TIMESTAMPTZ for consistency
|
||||
-- and low_stock_threshold for threshold tracking.
|
||||
|
||||
-- Add expires_at column for precise expiry date/time tracking (complementing existing expiry_date)
|
||||
-- We'll keep both: expiry_date (DATE) for simple day-based expiry, expires_at (TIMESTAMPTZ) for precise tracking
|
||||
ALTER TABLE inventory_items
|
||||
ADD COLUMN expires_at TIMESTAMP WITH TIME ZONE DEFAULT NULL;
|
||||
|
||||
-- Add low_stock_threshold column for low-stock alerts
|
||||
ALTER TABLE inventory_items
|
||||
ADD COLUMN low_stock_threshold NUMERIC(10,2) DEFAULT NULL;
|
||||
|
||||
-- Add comments for documentation
|
||||
COMMENT ON COLUMN inventory_items.expires_at IS 'Optional precise expiration timestamp. Complements expiry_date for items needing time-specific expiry.';
|
||||
COMMENT ON COLUMN inventory_items.low_stock_threshold IS 'Minimum quantity threshold. Item is considered low-stock when quantity <= threshold. Null means no threshold set.';
|
||||
|
||||
-- Create index for efficient expiry queries (finding items expiring soon)
|
||||
CREATE INDEX idx_inventory_items_expires_at ON inventory_items(expires_at) WHERE expires_at IS NOT NULL;
|
||||
|
||||
-- Create index for efficient low-stock queries
|
||||
CREATE INDEX idx_inventory_items_low_stock ON inventory_items(quantity, low_stock_threshold)
|
||||
WHERE low_stock_threshold IS NOT NULL;
|
||||