{"id":22343242,"url":"https://github.com/eddmann/secret-santa-draw","last_synced_at":"2025-07-23T02:33:53.140Z","repository":{"id":265514532,"uuid":"896158635","full_name":"eddmann/secret-santa-draw","owner":"eddmann","description":"Bringing the holiday cheer by making Secret Santa draws a breeze to organise, whether gathered around the tree or connected online! 🎄","archived":false,"fork":false,"pushed_at":"2024-12-11T18:47:41.000Z","size":6531,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T09:46:04.097Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://secret-santa.eddmann.com/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eddmann.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-29T17:04:00.000Z","updated_at":"2024-12-11T18:47:45.000Z","dependencies_parsed_at":"2025-03-26T09:43:28.885Z","dependency_job_id":"1907318d-ee8b-4dd4-bf92-1d2049f121a3","html_url":"https://github.com/eddmann/secret-santa-draw","commit_stats":null,"previous_names":["eddmann/secret-santa-draw"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eddmann/secret-santa-draw","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eddmann%2Fsecret-santa-draw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eddmann%2Fsecret-santa-draw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eddmann%2Fsecret-santa-draw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eddmann%2Fsecret-santa-draw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eddmann","download_url":"https://codeload.github.com/eddmann/secret-santa-draw/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eddmann%2Fsecret-santa-draw/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266606669,"owners_count":23955328,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-04T08:15:30.938Z","updated_at":"2025-07-23T02:33:53.119Z","avatar_url":"https://github.com/eddmann.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🎅 Secret Santa Draw\n\n\u003ca href=\"https://apps.apple.com/gb/app/secret-santa-draw/id6738795018\"\u003e\u003cimg src=\"https://developer.apple.com/assets/elements/badges/download-on-the-app-store.svg\" /\u003e\u003c/a\u003e\n\n[API](./api/) | [Client](./client/) | [iOS](./ios/)\n\nThis year's offering expands upon last year's [PWA](https://github.com/eddmann/secret-santa-pwa), transforming it into a full-fledged platform complete with an accompanying iOS/Android application (coming soon).\nIt brings holiday cheer by making Secret Santa draws a breeze to organise, whether gathered around the tree or connected online! 🎄\n\nThe service was built in a RAD manner, with a self-imposed time constraint of just a couple of evenings for development - driven by the goal of getting something shipped! 🚀\n\n## Features\n\n- **Local In-Person Draws**: Conduct offline Secret Santa draws, retaining the functionality of the [original PWA](https://github.com/eddmann/secret-santa-pwa).\n- **Online Remote Draws:**\n  - Register and create groups to manage annual Secret Santa draws.\n  - Add participants with names and email addresses.\n  - Apply allocation exclusions (e.g., couples, previous pairings).\n- **Automated Email Notifications**: Participants receive an email with their Secret Santa allocation.\n- **Gift Ideas Management**: Participants can provide and view gift ideas for their assigned allocation.\n- **Account Registration:**\n  - Participants can optionally register with the service.\n  - Allocations are linked to accounts based on email address, consolidating access to all associated draws.\n\n## Future Features\n\n- **Prefill Draw Entries**: Automatically populate draw participants from the previous year's draw.\n- **Enhanced Gift Ideas**: Support for various idea types (URLs, images, etc.).\n\n## 🛠️ Technical Overview\n\nThis project builds on last year's PWA by incorporating a backend API, enabling remote draw capabilities and account-based access.\n\n### Backend API\n\n- RESTful HAL-based API, embracing HATEOAS principles.\n- Laravel 11, with Sanctum for cookie-based sessions\n- PostgreSQL\n- PHP 8.4\n- Lambda Bref for Serverless deployment\n- Email notifications sent using the Laravel Jobs queue\n\n### Client Application\n\n- React, with React Router\n- TypeScript\n- Vite\n- PWA features, such as offline support\n- Uses the [Ketting](https://github.com/badgateway/ketting) HTTP library to manage access to the HAL-based API\n\n### iOS Application\n\n- Thin application which wraps PWA\n- Swift\n- Universal Link support\n- Based on the great [ios-pwa-wrap](https://github.com/khmyznikov/ios-pwa-wrap) project!\n\n### Infrastructure\n\n- AWS CDK for IaC concerns\n- Lambda Bref for Serverless API deployment\n- SQS for background/asynchronous Laravel jobs\n- S3 bucket for static Client deployment\n- Fronted by a CloudFront distribution that manages caching concerns\n\n## Other Years\n\nInterested in seeing how I over-engineered the problem of allocating Secret Santa's in other years?\n\n- 2020 - [Clojure Secret Santa](https://github.com/eddmann/clojure-secret-santa)\n- 2021 - [Pico Secret Santa](https://github.com/eddmann/pico-secret-santa)\n- 2022 - [Step Function Secret Santa](https://github.com/eddmann/step-function-secret-santa)\n- 2023 - [Secret Santa PWA](https://github.com/eddmann/secret-santa-pwa)\n- 2024 - [Secret Santa Draw](https://github.com/eddmann/secret-santa-draw)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feddmann%2Fsecret-santa-draw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feddmann%2Fsecret-santa-draw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feddmann%2Fsecret-santa-draw/lists"}