Skip to content

CodeCarefully/WeddingBliss

maintenance python gpl coverage coverage

WeddingBliss

Wedding invite system and manager

Version: 0.1a1 GIT:014e2ab
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgements

About The Project

Weddings are supposed to be the "best part" of the relationship - the pinnacle of commitment. It's a party you invite all your friends and family to.

But:

Weddings are a huge stressful mess - complicated by the lack of RSVPs, expensive markups and sheer inexperience at organizing huge parties.

I started building the original version of this site for my own wedding, years ago. Since then much has changed, including a global pandemic. I've kept up, making many versions of this for all my friends.

The original PHP version had many flaws, including an utterly exhausting level of work required to build and design the backend pages.

I've been trying to make a Django version of the project for years, this is my latest, and hopefully last attempt at it.

Built With

Getting Started

Prerequisites

Installation

Make sure to generate a new secret with:

python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'

Usage

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Project Scope:

  • Project Should be in Django, using the latest version
  • Project should have the ability to send emails and SMS messages, with a configurable account.
  • Docker Deploy

Flow:

For user:

* User gets message, clicks link, is brought to site
* Can see wedding info, including possible "zoom" or other meeting link
* Given Options to RVSP and provide additional details
* Get ICAL/Gcal links

For admin:

* Add users with a range of details and permissions (email, phone number, who they can invite, etc..)
* See stats like "Open rate"
* Ability to auto-reach out based on stat criteria (people who didn't open, etc..)
* see cute personalized messages as event approaches.
* configure API keys for SMS and email sending service/SMTP
* Customize template
* secure backend login
* ability to export site
* Password Recovery
* Seating arrangement?
* Export people by various criteria to excel/CSV
* Can set which meeting service they want (Zoom, etc..) and when it "starts"
(to allow stateless services like Jitsi without losing moderator control)
* Can change meeting links on the fly, since its just a redirector.
* compliance with COVID regulations and TAV Yarok. Including fetching updates from COVID advisory sites.
* save the date page, which lets you get basic info and add in your email? for updates.(simplepush?)
* Populate data for Ical/Gcal links

Random Thoughts:

I'd really like to use WebAuthN/social/djangoauth for the backend login to provide a range of options

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Make sure your code has tests, and that the built-in ones are passing after your change. To run tests:

coverage run -m pytest

To generate a nice HTML report:

coverage html

License

Distributed under the GPLv3 Licence. See LICENSE for more information.

Acknowledgements

  • I'd like to thank my beautiful spouse for marrying me and giving me the idea.
  • I got some inspiration and a few snippets from django-wedding-website by the lovely Cory Zue for his wedding with Rowena
  • Also Django. Thanks Django!

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published