dds_registration

A Django App to manage DdS membership and event registration.

User accounts

A user account is required for using the membership and events portal. User account emails must be verified. We use the built-in Django verification code.

sequenceDiagram
    User->>Frontend: Enter user details
    Frontend->>Backend: User account created
    Backend->>Sendgrid: Verification email request
    Sendgrid->>User: Verification email sent
    User->>Frontend: Click on verification link
    Frontend->>Backend: Mark user account verified

Payments

Users can chose to pay by invoice or by credit card (via Stripe) for an extra fee. The extra fee covers the money we lose to Stripe; the exact amount varies by currency, but is enough that we need to account for it.

All payments are processed the same way:

sequenceDiagram
    User->>Frontend: Sign up for membership or for-cost event
    opt Invoice
        Frontend->>Backend: Create `Payment` object with status `ISSUED`
        Backend->>Sendgrid: Request email with invoice PDF
        Sendgrid->>User: Send email with invoice PDF
        User->>Wise: Make payment
        Note over User,Wise: Can take several days or weeks
        Wise->>Staff: Payment received notification
        Staff->>Admin site: `Mark selected invoices paid` admin action
        Admin site->>Backend: Change `Payment` object status to `PAID`
        Backend->>Sendgrid: Request email with receipt PDF
        Sendgrid->>User: Send email with receipt PDF
    end
    opt Stripe
        Frontend->>Stripe: Create payment intent
        Frontend->>User: Redirect to Stripe payment page
        User->>Stripe: Enter payment details
        Stripe->>Frontend: Redirect to payment processed page
        Frontend->>Backend: Create `Payment` object with status `PAID`
        Backend->>Sendgrid: Request email with receipt PDF
        Sendgrid->>User: Send email with receipt PDF
    end
    Frontend->>User: Redirect to `profile` page

Membership

DdS membership runs per calendar year, from January 1st to December 31st. Signing up for DdS membership requires a valid user account.

sequenceDiagram
    User->>Frontend: Sign up for user account
    Note over User,Frontend: Enter payment process

To give an honorary membership, ask the user to sign up for an invoice, and then delete the payment and set membership status to HONORARY.

Event registration

Events with applications

An event with an application requires people to apply, and some or all of the applicants can be selected. To create an event with an application, you need to have an admin account, and can then do the following:

First, Create a new event. You will need to fill in the event title and description (plain text for now), but also supply the following:

Application submitted email: The email sent when users submit an application to join the event. This should thank them, let them know when they can expect a decision, and let them know that they can edit their answers at anytime. The URL to edit the application is shown at the bottom of the page ("Edit registration url").
Application accepted email: The email sent when the application is accepted, and the user can actually register for the event and enter payment information (if required - skipped if the price is zero). The URL to register for the event is the same as the one to create or edit an applicaition - "Edit registration url" at the bottom of the page.
Application rejected email: The email sent when an application was not accepted, due to space constraints or other reasons.
Success email: The email sent when registration is successful. This should give instructions on what to expect, logistics, etc.

Next, if your event has a price, create at least one registration option, and associate it with the event. If your event is free, make sure to check Free in the Event admin page.

You then need to create an application form. The graphical buttons are not always straightforward here, some experimentation is needed.

Finally, go back to the event admin page, and select the new application form for your event. If you want this event to be shown on the homepage, select Public; otherwise, you can email the registration link to people you want to invite.

sequenceDiagram
    User->>Frontend: Goes to registration URL for first time
    `event_registration` View->>User: Redirect to application creation URL
    User->>Frontend: Enter application information and submit
    Frontend->>Backend: Enter `Registration` object with status `SUBMITTED`
    Note over User,Frontend: User can go to same URL to edit application
    Staff->>Admin: User is accepted via `accept_application` admin action
    Admin->>Backend: `Registration` status updated to `SELECTED`
    Backend->>Sendgrid: Request email with registration URL
    Sendgrid->>User: Send email with registration URL
    User->>Frontend: Enter registration information
    Note over User,Frontend: Enter payment process

Development

The dev_server.sh script is here to help setting up a development site.

./dev_server.sh run

This will start a local dev server running with its own virtualenv.

./dev_server.sh test

This will run all the tests currently available in the codebase and provided by Django.

./dev_server.sh --help

For more options the script has to offer.

Releasing

Preparation

Update setup.cfg with the new version number and commit
Merge all desired changes to master
Create a release in GitHub with a summary description, including creating a new tag v.

Automatic release

Github Actions take care of everything.

Manual release process

A little more involved but it's Okay I guess

rm -rf build/ dist/ django_dds_registration.egg-info/
python setup.py sdist
twine upload dist/*

sentier-dev / dds_registration

readme