Git Product home page Git Product logo

secret-santa's Introduction

Secret-Santa

Secret-Santa is an application specifically designed to simplify the process of organizing gift exchanges. With this app, users can easily organize a gift exchange without the need for manually drawing names from a hat or pieces of paper.

Features

  • Rule sets
  • Send per Email

Installation

You only need to download the binary for your OS, from the latest release. After extracting the zip or tar archive, you can use the binary.

Get started

  1. Setup Configuration file
  2. Setup Env variables
  3. Run application

Configuration

config.yaml

users: # Register Users
  - name: Clara
    email: [email protected]
  - name: Tom
    email: [email protected]
  - name: Jonas
    email: [email protected]
  - name: Max
    email: [email protected]
  - name: Lena
    email: [email protected]
  - name: Leo
    email: [email protected]
  - name: Jan
    email: [email protected]

forbiddenCombinations: # Write down forbidden combinations
  - combination:
      - Max    # Max can never get Lena
      - Lena   # Lena can never get Max
  - combination:
      - Jonas
      - Jan
  - combination:
      - Clara # Clara can never get Leo or Tom
      - Leo
      - Tom

summaryEmail: [email protected]

emailConfig:
  subject: SecretSanta 2023
  content: Hi %v, your gift goes to %v # The first %v is the mail receiver name and the second %v is the name where the gift goes to

Flags

Flag Description
y Sends emails directly

Env variables

Configure email credentails. Set as environment variables, or write in a .env file

MAIL_SENDER=[email protected]
MAIL_PW=123
MAIL_SMTP_SERVER=smtp.domain.example
MAIL_SMTP_SERVER_PORT=587

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.