Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.17 KB

readme.md

File metadata and controls

38 lines (26 loc) · 1.17 KB

Secret Santa Mailer

A simple script that allows you to anonymously assign gifts from a random category to generated pairs of people - rules

Preparation

Clone the repo and install dependencies. Then you should copy .env.example file into .env and insert your Gmail credentials into it.

Disclaimer: For now, only gmail mails are supported, you should also have a "Less secure apps access" enabled

Now you can fill all users that will participate in the game, to do this you need to copy users.json.example into users.json and fill in players details as in example:

[
  {
    "name": "test",
    "mail": "test@example.com
  }
]

You have to do simmilar thing with a categories.json.example file. There you can enter as many categories of gifts you want.

Banned pairs

Sometimes, you may not want to allow person X to make a gift for person Y. You can ban that pair in banned.json file (Copy pattern from banned.json.example).

Sending mails

If you prepared all data, you can simply run a script using:

$ yarn start
or
$ npm run start