Skip to content
RESN
GitHub

Users

Introduction

This API is the least well-structured. At the moment, it contains code for user registration, editing account and editing subjects. It also contains the endpoints for admin access to user accounts and approving users.

At some point, some of this stuff should probably be split off into an authentication-related service (registration + login).

Emails

  • New student alert
    • Sent to all Student Admins
    • Contains a link to the student’s admin page so they can be accepted
  • Student accepted
    • Sent to the student after accepted
    • Contains intro to RESN and information about available services
  • New volunteer alert
    • Sent to all Team Admins
    • Contains a link to the volunteer’s admin page so they can be accepted
  • Volunteer accepted
    • Sent to the volunteer after accepted
    • Contains guidelines for interacting with students
    • Also provides links to our private Facebook and Discord groups
  • EOI received
    • Students are sent a form at the end of year 12 asking if they want to join our tutoring team
    • This email confirms we have received their EOI
  • Ask for school email
    • Students may sometimes sign up with only their personal email
    • This is a manual admin email which asks them to update their account details
  • Non-rural school
    • This email is sent out to students who do not meet eligibility for RESN
    • This is a manual admin email after reviewing the account details
  • Password reset email
    • For when a user has forgotten their password
    • Generates a JWT token which is used to validate the new password form
  • Confirm email
    • This is generated after signing up or adding an email
    • Sent to a specific address (not necessarily the user’s primary address)
    • Generates a JWT token which is used to validate the user can access that email
  • Changed subjects alert
    • Sent to the Head of Education when a tutor edits their requested subjects
    • This is important as an admin needs to confirm access to new subjects
  • Confirm email reminder
    • This is part of a background task
    • Sends an email requesting the user confirms their address every 7 days
    • Stops requesting after 2 months (this is probably too long)