Skip to content

Quick Start Guide

Get Digital Memory Chest running in just a few minutes and see the magic of AI-powered memorials in action.

🚀 One-Command Demo

The fastest way to experience Digital Memory Chest is with our demo setup:

# Clone and run the complete demo
git clone https://github.com/your-username/digital-memory-chest
cd digital-memory-chest
python run_demo.py

This command will:

  • ✅ Install all dependencies
  • ✅ Set up the database with sample data
  • ✅ Create a complete memorial for Eleanor Thompson
  • ✅ Launch the web interface at http://localhost:8501

Digital Memory Chest Demo Welcome interface showing the Digital Memory Chest platform with Eleanor Thompson demo

Demo Includes

  • Sample Photos: Family gatherings, travel memories, and celebrations
  • Audio Recordings: Personal messages and stories
  • AI-Generated Story: Complete narrative with timeline and themes
  • Interactive Features: Sharing, contributions, and moderation

📋 Prerequisites

  • Python: 3.9 or higher
  • Memory: 4GB RAM minimum, 8GB recommended
  • Storage: 2GB free space for models and demo data
  • OS: Windows, macOS, or Linux
  • OpenAI API Key: For advanced transcription and story generation
  • Anthropic API Key: Alternative LLM provider
  • Note: All AI features work locally without external APIs

🛠️ Manual Setup

If you prefer step-by-step installation:

1. Install Dependencies

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install requirements
pip install -r requirements.txt

2. Configure Environment

Create a .env file with your preferences:

# Copy example configuration
cp .env.example .env

# Edit with your settings (optional)
nano .env

3. Initialize Database

# Set up database tables
python test_setup.py

4. Launch Application

# Recommended: Clean app startup with process management
python run_app.py

# Alternative: Direct startup (may conflict with existing processes)  
streamlit run app.py

Visit http://localhost:8501 to access Digital Memory Chest!

📱 First Steps Tutorial

Creating Your First Memory Chest

flowchart TD
    START([Start Application]) --> CREATE[Create New Chest]
    CREATE --> DETAILS[Add Person Details]
    DETAILS --> HERO[Upload Hero Image]
    HERO --> SAVE[Save Chest]
    SAVE --> UPLOAD[Upload First Memory]
    UPLOAD --> PROCESS[AI Processing]
    PROCESS --> STORY[Generate Story]
    STORY --> SHARE[Share Memorial]

    style START fill:#e3f2fd
    style CREATE fill:#e8f5e8
    style STORY fill:#f3e5f5
    style SHARE fill:#e1f5fe

Step 1: Create Memory Chest

  1. Click "Create New Memory Chest"
  2. Enter the person's name and dates
  3. Add a brief description
  4. Upload a hero image (optional)

Hero Image Tips

  • Choose a favorite photo that captures their essence
  • Square images work best (will be cropped to circle)
  • High resolution recommended (1000x1000px minimum)

Step 2: Upload Memories

Choose from multiple upload options:

  • Supported formats: JPG, PNG, HEIC, WebP
  • Max size: 100MB per file
  • Features: Automatic tagging, date extraction, thumbnail generation
  • Supported formats: MP4, MOV, AVI, MKV
  • Max size: 100MB per file
  • Features: Audio transcription, scene detection, thumbnail creation
  • Supported formats: MP3, WAV, M4A, OGG
  • Max size: 100MB per file
  • Features: Full transcription, speaker identification, keyword extraction
  • Supported formats: TXT, PDF, DOC, DOCX
  • Max size: 50MB per file
  • Features: Content extraction, keyword analysis, integration with timeline

Step 3: AI Processing

Watch as Digital Memory Chest automatically processes your uploads:

timeline
    title AI Processing Timeline

    Upload Complete    : File saved
                      : Metadata extracted
                      : Thumbnail generated

    AI Processing     : Audio transcribed
                     : Images tagged  
                     : Content analyzed

    Story Generation  : Timeline constructed
                     : Themes identified
                     : Narrative written

    Ready to Share   : Memorial complete
                    : Share tokens created
                    : Export options available

Processing Time

  • Photos: 10-30 seconds per image
  • Audio/Video: 1-2 minutes per minute of content
  • Story Generation: 2-5 minutes for complete narrative

Step 4: Review Generated Story

The AI creates a respectful, comprehensive narrative including:

  • Timeline: Chronological journey through life
  • Themes: Personality traits, values, and passions
  • Memories: Integration of uploaded content
  • Legacy: Impact on family and friends

You can: - ✏️ Edit any section - 🔄 Regenerate parts you'd like to improve - ➕ Add additional context or memories - 📤 Export in multiple formats

🔗 Sharing Your Memorial

Share Token System

Digital Memory Chest uses secure tokens instead of public URLs:

# Example share token (safe to share)
https://your-site.com/memorial/abc123token456def789

Benefits: - 🔒 Private by default: No public directory of memorials - 🚫 Revocable access: Disable tokens anytime
- ⏰ Time-limited: Set expiration dates - 📊 Access tracking: See who visits and when

Contribution System

Allow family and friends to add memories:

  1. Enable Contributions: Toggle on in memorial settings
  2. Share Contribution Link: Separate token for submissions
  3. Review Submissions: Moderate before publishing
  4. Approve/Decline: Full control over content

🎯 Common Use Cases

Memorial Services

Create beautiful tributes for: - Funeral Services: Display during services - Celebration of Life: Interactive memory sharing - Anniversary Remembrance: Annual commemoration - Family Gatherings: Share stories across generations

Personal Archives

Build living histories for: - Grandparents: Preserve family history - Military Service: Honor veterans' stories - Career Achievements: Professional legacies - Life Transitions: Milestone celebrations

Collaborative Memories

Involve the whole family: - Sibling Contributions: Different perspectives on shared memories - Grandchildren Stories: Multi-generational narratives - Friend Networks: Broader community memories - Extended Family: Inclusive memorial creation

🔧 Troubleshooting Quick Fixes

Common Issues

# Check Python version
python --version  # Should be 3.9+

# Reinstall dependencies
pip install --upgrade -r requirements.txt

# Clear cache
rm -rf __pycache__ .streamlit/
  • Check file size: Max 100MB per file
  • Verify format: See supported formats above
  • Free up space: Ensure adequate disk space
  • Restart app: Sometimes helps with memory issues
# Check logs
tail -f logs/processing.log

# Reset processing queue
python scripts/reset_queue.py

# Try with smaller files first
  • Reduce image sizes: Resize large photos before upload
  • Use local processing: Disable cloud APIs if slow
  • Clear browser cache: Refresh page with Ctrl+F5
  • Check system resources: Close other applications

⚡ Next Steps

Now that you have Digital Memory Chest running:


Getting Started Success

You should now have a fully functional Digital Memory Chest with sample content. The demo memorial for Eleanor Thompson showcases all major features and gives you a feel for the complete experience.