Events Documentation - samuelgrant/fight-for-kidz GitHub Wiki
Events
Introduction
Multiple events can be created and displayed on the Fight for Kidz website. Event creation and management begins on the 'Event Management' page accessable via the link on the side menu of the admin panel.
Each event can be set to public or private. Only public events will be visible on the public website, allowing the organizers to prepare future events ahead of time, and only display them when ready.
The upcoming event (the one linked to on the home page, and the on to which applications will be submitted) is determined by taking the public event with the latest datetime field. For this reason, it is important not to make a future event public if the preceding event has not yet taken place.
Events can be soft deleted, and subsequently restored. Events cannot be permanently deleted. If soft deleted, an event will automatically be switched to private, and will not display on the public website.
Event Database Structure
Each event has relationships to the following entities:
- Applicants
- Contenders
- Bouts
- Sponsors
- AuctionItems
Applicants
These represent all application form submissions to the event. The admins are able to view all applicants and assign them to either the red or blue teams. Assigning an applicant to a team generates a contender record/object based off of that applicant.
Photos uploaded by applicants are kept in private storage for privacy reasons, and can only be accessed by logged in admins.
Contenders
Each contender record represents an applicant that has been placed onto a team. Contender records have fewer personal details than applicants, and it is the contenders information that will be displayed on the public website.
Bouts
Each bout will be displayed on the public page for the event. Both a red and blue fighter must be selected or the bout will not show. There is no limit on how many bouts an event may have.
Sponsors
Sponsors may be added to the event from the sponsor management page. After being added to an event, the sponsor will appear in the sponsors bar for that particular event's page.
Bout sponsors and fighter sponsors may also be selected from the list of sponsors added to the event.
Bouts may be switched on or off individually for each event, allowing organizers to prepare them without showing to the public, whilst still display event information such as time and place.
Auction Items
Each event can have any number of auction items linked to it. These will appear at the bottom of the events public page. It is not neccessary to add auction items to an event.
Event Management Tabs
Overview
From this tab, the admins can view event information, as well as turn fighter applications on or off. Protections are in place to prevent applications being turned on inappropriately (e.g. if the event is in the past). The admins are able to see how many applications have been received, as well as how many of these have been assigned to teams.
Sponsors
From this tab, the admins can see all sponsors that have been added to the event. They can view the details of the sponsors, as well as remove them from the event. A sponsor cannot be removed from an event if it sponsors any of the bouts or fighters within.
In a future update, it is hoped that sponsors can be added to the event from this page. Currently they must be added from the global sponsors management page.
Bouts
From this tab, the admins can create/remove bouts, assign bout sponsors, assign fighters and record the winner and a URL linking to the video of the fight. Winner and fight video functionality is yet to be implemented
A bout will only show on the public page if both a red and blue fighter have been selected. A warning message will alert the admins of any bouts that fail to meet this requirement.
Bout visibility on the public page can also be toggled from this tab.
Contenders
From this tab, the admins can view all contenders that have been selected for the event. They are able to edit details for the contenders public bio, as well as the contenders stats, bio video, donation link and profile picture.
Applicants
From this tab, the admins can view all applicants and place them onto teams. They are able to sort and search through the data, and can also download all applicant data in the form of a spreadsheet. Currently the data exported to spreadsheet is limited to key data.
Auction
From this tab the admins can manage the auction items that have been added to the event.