Skip to content

README.demo.md

Latest commit

 

History

History
172 lines (106 loc) · 4.45 KB

README.demo.md

File metadata and controls

172 lines (106 loc) · 4.45 KB
Raw

Demo Mode Setup

This guide explains how to set up and run the Cocktail Manager in Demo Mode.

Overview

Demo Mode allows potential customers to try the software without requiring login credentials. Each visitor can create a demo workspace with pre-configured data that is automatically deleted after 24 hours.

Quick Start

  1. Start the demo instance:

The demo uses a pre-built Docker image from GitHub Container Registry. Simply start the containers:

docker-compose -f docker-compose.demo.yaml up -d

Note: The image is automatically built and pushed to ghcr.io/jo-gross/cocktail-manager-demo:latest via GitHub Actions when changes are pushed to the main branch.

To build locally instead (e.g., for development), uncomment the build section and comment out the image line in docker-compose.demo.yaml, then run:

docker-compose -f docker-compose.demo.yaml up -d --build
  1. Access the demo:

Open your browser and navigate to http://localhost:3001

  1. Click "Demo starten" to create a demo workspace

Configuration

Environment Variables

The demo instance uses the following environment variables (set in docker-compose.demo.yaml):

  • DEMO_MODE=true - Enables demo mode
  • DEMO_WORKSPACE_CONFIG_PATH=/app/config/demo-workspace-config.json - Path to demo configuration
  • DEMO_TTL_HOURS=24 - Time-to-live for demo workspaces in hours

Demo Configuration File

Edit config/demo-workspace-config.json to customize the demo data:

  • Workspace name and description
  • Cocktail recipes with ingredients, steps, and garnishes
  • Glasses
  • Ingredients
  • Garnishes

Cleanup

The cleanup job runs automatically every hour via a cron job in the cleanup-cron container. It:

  • Finds all expired demo workspaces (where expiresAt < now())
  • Deletes expired workspaces and all related data
  • Deletes demo users if they have no remaining workspaces

Manual Cleanup

You can also trigger cleanup manually:

# Via API endpoint (if running)
curl -X POST http://localhost:3001/api/demo/cleanup

# Or directly via script
docker exec cocktail-manager-demo-cleanup node scripts/cleanup-demo-workspaces.js

Ports

The demo instance uses different ports to avoid conflicts with production:

  • Application: 3001 (instead of 3000)
  • PostgreSQL: 5433 (instead of 5432)
  • Chromium: 9223 (instead of 9222)

Database

The demo uses a separate database (cocktail_recipe_demo) to ensure complete isolation from production data.

Stopping the Demo

docker-compose -f docker-compose.demo.yaml down

To also remove volumes (including database data):

docker-compose -f docker-compose.demo.yaml down -v

Troubleshooting

Cleanup not working

Check the cleanup logs:

docker logs cocktail-manager-demo-cleanup

Database connection issues

Ensure the postgres container is running:

docker ps | grep postgres-demo

Config file not found

Make sure the config directory is mounted correctly. The docker-compose file mounts ./config:/app/config:ro

Docker Image

Pre-built Image

The demo uses a pre-built Docker image from GitHub Container Registry:

  • Image: ghcr.io/jo-gross/cocktail-manager-demo:latest
  • Built via: GitHub Actions (.github/workflows/build-demo-image.yml)
  • Build args: DEPLOYMENT=demo, DEMO_MODE=true

Building the Image

The image is automatically built and pushed when:

  • A GitHub Release is published
  • Workflow is manually triggered via GitHub Actions UI

The image version is automatically read from package.json and used as the image tag.

Image Tags

The workflow creates two tags for each build:

  • <version> - Version from package.json (e.g., 1.17.1)
  • latest - Always points to the latest published release

Example: If package.json has version 1.17.1, the image will be tagged as:

  • ghcr.io/jo-gross/cocktail-manager-demo:1.17.1
  • ghcr.io/jo-gross/cocktail-manager-demo:latest

Pulling the Image

To pull the latest image manually:

docker pull ghcr.io/jo-gross/cocktail-manager-demo:latest

Note: You may need to authenticate with GitHub Container Registry:

echo $GITHUB_TOKEN | docker login ghcr.io -u USERNAME --password-stdin

Production Deployment

For production deployment, ensure:

  1. Set a strong BETTER_AUTH_SECRET
  2. Set the correct BETTER_AUTH_URL
  3. Use proper database credentials
  4. Configure authentication providers if needed (see docs/AUTH.md)