Skip to content

Latest commit

 

History

History
338 lines (248 loc) · 10.6 KB

README.md

File metadata and controls

338 lines (248 loc) · 10.6 KB
Raw

Contributors Forks Stargazers Issues


Logo

Secret Santa New Generation

An awesome secret santa app with gifts ideas and random generation!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

User Dashboard Screenshot

Secret Santa New Generation is a modern app that simplifies your Secret Santa organization. Here are the main features:

  • 🔒 Secure draw: No one, not even the admin, can know who gives to whom
  • 🎁 Wishlist: Each participant can create and manage their gift wishlist
  • 💡 Gift suggestions: Ability to suggest ideas for other participants
  • 📱 Responsive interface: Works on mobile, tablet, and desktop

(back to top)

Built With

  • Next
  • Tailwind
  • Prisma

(back to top)

Getting Started

This guide explains how to set up and deploy the application in different environments.

Prerequisites

  • Node.js 18+
  • Git
  • Docker (optional)

Local Development Setup

  1. Clone the repository
git clone https://github.com/theoelsti/secret-santa-ng.git
cd secret-santa-ng
  1. Configure environment
# Copy example environment file
cp example.env .env

# Edit .env and set your variables
ADMIN_TOKEN="your_admin_token"
DATABASE_URL="file:./dev.db"
  1. Install and run
# Install dependencies
npm install

# Initialize database
npx prisma migrate dev

# Run development server
npm run dev
# or
# Build and run production
npm run build
npm start

Production Deployment

Using Docker (Recommended)

# Build the Docker image
docker build -t secret-santa-app .

# Run the container
docker run -p 3000:3000 \
  -e ADMIN_TOKEN="your_admin_token" \
  -e DATABASE_URL="file:./prod.db" \
  secret-santa-app

The application will be available at http://localhost:3000 for local development

Using Vercel

  1. Get a Postgres server. You can use Neon.tech

  2. Fork the repository

  3. Connect to Vercel

  4. Add New -> Project

  5. Import the repository

  6. Add environment variables in Vercel dashboard

  7. Deploy!

The app url will be available on the dashboard.

Usage

For administrators

  1. Create a family

    • Log in with your admin token
    • Click on "Ajouter une famille"
    • Enter Family name
    • Add members and add their name
    • When done, click "Générer le Secret Santa"

    Create Family

You wil be redirected on the users management page
  1. Share the word
    • You can copy a message or the user token
    • Send it 1 by 1 to every participants
    • They will have an url that put the token in cookies directly

For participants

  1. Getting started

    • Log in to the dashboard
    • See the person you're offering to

  2. Giving ideas for gifts

    • Select a participant, can be you 1 time
    • Enter the gift in the input
    • Send it !

Gift List

For more examples, please refer to the Documentation

(back to top)

Configuration

Environment Variables

# Required
ADMIN_TOKEN="your_admin_token"
DATABASE_URL="your_database_url"

Roadmap

  • 📨 Email notifications
  • 🌐 Multi-language support (FR, EN)
  • 🔄 Integration with Amazon/Etsy for wishlists
  • 🎨 Dark Theme
  • 📊 Advanced admin features
    • Add a deadline
    • Set a budget

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  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

(back to top)

Top contributors:

contrib.rocks image

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/theoelsti/secret-santa-ng

(back to top)

Acknowledgments

(back to top)