https://github.com/mattriley/node-kris-kringle
Christmas gift-giving made easy by randomising a draw and notifying players of their KK by SMS text message.
https://github.com/mattriley/node-kris-kringle
christmas fun javascript kris-kringle nodejs npm-package secret-santa sms
Last synced: 2 months ago
JSON representation
Christmas gift-giving made easy by randomising a draw and notifying players of their KK by SMS text message.
- Host: GitHub
- URL: https://github.com/mattriley/node-kris-kringle
- Owner: mattriley
- Created: 2019-12-20T22:48:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-02T13:17:57.000Z (over 1 year ago)
- Last Synced: 2024-04-24T13:44:59.937Z (about 1 year ago)
- Topics: christmas, fun, javascript, kris-kringle, nodejs, npm-package, secret-santa, sms
- Language: JavaScript
- Homepage:
- Size: 2.69 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README-TEMPLATE.md
Awesome Lists containing this project
README
<%- lib.renderOpening() %>
## Install
<%- await lib.renderCode('npm install kris-kringle', '', 'https://www.npmjs.com/package/kris-kringle'); %>
SMS notifications are sent using AWS SNS and requires an AWS profile to be configured.
## Usage
```
kk
```
`configJsonFile` defaults to `config.json`.
## Example
<%- await lib.renderCode(lib.fetchCode('config-example.json')) %>
Text messages:
- Hey foo! Your KK is baz. The spend is $100. Merry Christmas! 🎅🏻🎄
- Hey bar! Your KK is foo. The spend is $100. Merry Christmas! 🎅🏻🎄
- Hey baz! Your KK is bar. The spend is $100. Merry Christmas! 🎅🏻🎄
See [`src/default-config.json`](https://github.com/mattriley/kris-kringle/blob/master/src/default-config.json) for other config options.
## Architecture
<%- await lib.renderModuleDiagram() %>