Skip to content

A modern Secret Santa organizer that replaces paper-based name drawing with instant digital room creation and automated gift assignments, perfect for remote teams and families.

License

Notifications You must be signed in to change notification settings

kevinnadar22/Secret.Santa.Shuffle

Repository files navigation

🎅 Secret Santa Shuffle

Tired of drawing names from a hat? Make Secret Santa fun and easy with digital shuffling!

Secret Santa Shuffle Preview

License: MIT Python Flask Socket.IO TailwindCSS Code style: black Deploy to Heroku

🎯 No More Paper Slips | 🌍 Perfect for Remote Groups | ⚡ Instant Results

Say goodbye to the traditional paper-based Secret Santa! Create digital rooms instantly, invite participants, and let the app handle the gift assignments automatically. Perfect for remote teams, families, and friend groups across the globe!

FeaturesInstallationDeploymentContributing


📋 Table of Contents

✨ Features

🎯 Core Features 🛠️ Technical Features 🎨 UI Features
Gift Assignment WebSocket Responsive Design
Room Creation Cache Storage Modern Interface
Room Codes Session Management Animated Transitions

⚙️ Configuration (Optional)

The application uses environment variables for configuration. Create a .env file in the root directory:

# Required
DOMAIN=http://localhost:5000   # Your application domain
SECRET_KEY=your_secret_key       # Secret key for session security

# Optional
DEBUG=False                      # Set to True for development

Environment Variables

Variable Description Default
DOMAIN Application domain URL http://localhost:5000
SECRET_KEY Flask secret key "dev"
DEBUG Debug mode flag False

🚀 Quick Start

# Clone repository
git clone https://github.com/kevinnadar22/Secret.Santa.Shuffle
cd Secret.Santa.Shuffle

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

# Install dependencies
pip install -r requirements.txt

# Run application
python run.py

Visit http://localhost:5000 in your browser.

🌐 Deployment

Heroku

One-click deployment:

Deploy to Heroku

Docker

# Build image
docker build -t santa-shuffle .

# Run container
docker run -p 5000:5000 \
  santa-shuffle

🤝 Contributing

We welcome contributions! Here's how you can help:

  1. Fork the repository
  2. Create your feature branch
    git checkout -b feature/AmazingFeature
  3. Commit your changes
    git commit -m 'Add some AmazingFeature'
  4. Push to the branch
    git push origin feature/AmazingFeature
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.


Made by Kevin Nadar

About

A modern Secret Santa organizer that replaces paper-based name drawing with instant digital room creation and automated gift assignments, perfect for remote teams and families.

Topics

Resources

License

Stars

Watchers

Forks