event-tools

README

Event-Tools

[!WARNING] This codebase is under active development. IT IS NOT READY FOR PRODUCTION!

Are we Event-Tools yet?

1. Registry (Core Feature)

• Public registry pages
• Custom registry links
• Item management
  • Categories
  • Editing
  • Archiving
  • Images
• Fulfillment model
  • Item reservations
  • Reservation expiration
  • Reservation management links
  • Guest purchase tracking
• Cash funds
  • Contributions
  • Payouts
• Post-event
  • Thank you tracking

2. RSVP / Event Management (Core Feature)

• Public RSVP pages
• Invite system
  • Invite codes
  • Guest groups
• RSVP data
  • Event-level responses
  • Plus-ones
  • Meal choices
  • Guest accommodations
  • Custom questions

3. Accounts & Relationships

• Authentication
• Account management
• Partner system
  • Partner linking
  • Invite/accept flow
• Account recovery

4. Media & Storage

• S3 storage
• Registry item images
• Receipt uploads
• Event/gallery images

5. Notifications

• Email system
  • Purchase notifications
  • Reservation expiration reminders
  • RSVP reminders

6. Payments

• Stripe Connect onboarding
• Cash fund payouts
• Contribution history

7. Admin / Management UX

• Registry management view
• RSVP management view
• Guest list management
• Couple settings
• Activity/audit views

8. Platform / Reliability

• Rate limiting / anti-abuse
• Audit logging
• Error handling / error pages
• Mobile responsiveness
• Accessibility

9. Compliance & Security

• Privacy / Legal
  • Privacy policy
  • Terms of service
  • Data processing disclosure
  • Data retention policy
  • Subprocessor disclosure (S3, email, Stripe)
• User rights
  • Data export
  • Data deletion
• Security
  • Email verification
  • Password reset

---

Setup/Building:

env: cp .env.example .env

build: ./build.sh

build & run: ./build.sh -run

dev: ./build.sh -dev

dev & run: ./build.sh -dev -run

package: ./build.sh -package

PG, Valkey, & Garage:

• Configure relevant variables in .env
• docker compose up -d

Full options:

Usage: ./build.sh [OPTION...]

        -dev            Builds dev binaries.
        -run            Run built binary.
                         Runs Linux binary unless only Windows binary is built.
        -linux          Builds Linux binary.
        -windows        Builds Windows binary.
        -mac            Builds macOS binaries.
                         UNIMPLEMENTED!
        -arm            Builds binaries for arm.
                         UNIMPLEMENTED!
        -arm64          Builds binaries for arm64.
                         UNIMPLEMENTED!
        -x86            Builds binaries for 32-bit x86.
                         UNIMPLEMENTED!
        -amd64          Builds binaries for amd64. (Default)
                         UNIMPLEMENTED!
        -licenses       Collects licenses for imported modules.
                         Saves to ./LICENSES/
        -package        Collects licenses and packages them with the compiled binary(s).
        -help           Prints help

Third-party licenses are bundled in release archives under LICENSES/.

---

AI Disclaimer: Project is not vibe coded, but I do use Sourcery to help with code reviews, refactors, more sensible commit messages, and occasionally for code examples when absolutely needed. DB schema was partially generated as an initial checklist of functionality to work towards and will be heavily adjusted/modified as the app progresses.

If the code quality is crap that is my own fault. 💜