Merge branch 'main' into issue-70-Add_projects_to_member_pages

Author: laurenpudz

.gitignore

@@ -293,5 +293,6 @@ dist
 
 # misc
 .DS_Store
+.cursor/
 
 opt/

client/documentation/admin-dashboard/committee.md

@@ -0,0 +1,13 @@
+## Committee Members
+
+Profiles of the Committee Members of the club that are displayed on the about page.
+
+## Fields
+
+**Id:** Required and unique field for the club member that is on the committee. It is an integer field that corresponds to the raw integer id of a row in the Member table, as a Foreign Key if you know databases.
+
+**Role:** Required and unique field for the specific role in the committee that this member has. It is something known as an Enum (Enumeration), which has a discrete number of custom choices. You can choose from 'President', 'Vice President', 'Secretary', 'Treasurer', 'Marketing', 'Events OCM', 'Projects OCM', and 'Fresher Rep'. Since they must be unique, you can only have 8 objects in the Committee table at a time for now. This can definitely be changed in the future when the committee grows.
+
+## Other Notes
+
+Before making a Committee object in the Committee table, you must make a Member object for the person that's on the committee and then link it through the id (just to clarify)

client/documentation/admin-dashboard/games.md

@@ -0,0 +1,31 @@
+## Games
+
+Pages for games can be added and edited at the row 'Game' of the GAME_DEV section on the main admin page.
+
+### Fields
+
+**Name:** Required field for the game's name. A character field (includes letters, numbers and symbols) of maximum length 200 characters.
+
+**Descripiton:** Required field for the game's description. A text field.
+
+**Completion:** Required field for the game's completion. A multichoice option field with four options including:
+ - "Work in progress (Unplayable)"
+ - "Playable - In Development"
+ - "Beta - Stable but not Final"
+ - "Completed" 
+
+**Active:** Required field for if the game is continued to be being worked on. A boolean field.
+
+**Host URL:** Optional field for the game's host URL. A URL field with a maximum length 2083 characters
+
+**Itch Embed ID:** Optional field for game's embed. If the field is empty the game will display a custom embed ID at the bottom of the page. This value can be gotten from the itch.io page of the game, at the bottom of the page there is an embed button, clicking this will bring up a full embed, the only part needed is the 7 digit number after "https://itch.io/embed/".
+
+**Thumbnail:** Required field for the game's thumbnail. This image is displayed on the game page in place of a game embed or displayed within the game embed before the play button is pressed. Must be an image file.
+
+**Event:** Optional field for the event at which the game was created. Links the game to an event. Foreign key field for an event.
+
+**Itch Game Embed ID:** Optional field for the game's game embed. This ID allows the web version of a game to be played inside the site. This value can be acquired in two ways, either by the developer or through looking in the page source. A developer can get the value by going to the distribution tab of their game and going to the embed game section this will bring up a full embed for the game and the only part needed is the 8 digit number after "https://html-classic.itch.zone/html/". By looking through the page source that link can also be found either in a div or an iframe on the page depending on if the game has been played. **This value is not attainable if there is no web version of the game. hosted on itch.**
+
+**Itch Game Width:** Required field for the game's game embed. This value is gotten in a similar way to the Itch Game Embed, however for the developer it's the number after "width=" and in the page source is found after "data-width=".
+
+**Itch Game Height:** Required field for the game's game embed. This value is gotten in a similar way to the Itch Game Embed, however for the developer it's the number after "height=" and in the page source is found after "data-height=".

client/documentation/admin-dashboard/members.md

@@ -0,0 +1,17 @@
+## Member Profiles
+
+Profiles of club members can be added and edited at the row 'Member' of the GAME_DEV section on the main admin page.
+
+### Fields
+
+**Name:** Required field for the member's name. A character field (includes letters, numbers and symbols) of maximum length 200 characters.
+
+**Active:** Checkbox to represent whether a member is an active participant in the club. If the checkbox is not ticked then the member's profile will not be displayed on the website.
+
+**Profile Picture:** Optional field to upload a profile picture. Must be an image file, and will display best if the image is at least 128 by 128 px in size. If no profile picture is provided then the member's initials will be displayed instead.
+
+**About:** Optional field for a bio. A character field of maximum length 256 characters.
+
+**Pronouns:** Optional field for the member's pronouns. A character field of maximum length 20 characters.
+
+**Social media links:** Optional section to display links to the member's social media profiles. Requires a link to the profile (character field of maximum length 2083) and, optionally, the profile username (character field of maximum length 200). If a username is not supplied then only a social media icon will be displayed with the link attached, otherwise the username will be placed next to the relevant icon. The type of icon to be displayed (e.g. instagram, linkedin, generic link) is inferred from the social media link provided.

client/documentation/pages/about-committee.md

@@ -0,0 +1,11 @@
+## About/Committee Page
+
+Has a description of the club, it's aim's etc, along with a big feature photo, intended to be a group photo of the committee or a big event? Then below is a display of all the current committee members of the club, showing name, role and pronouns.
+
+## Hardcoded content to be modified by committee members
+
+The club description and feature photo are the only things hardcoded into the website's front-end. Starting from the root directory of this website's source, this code to modify can be found in /client/src/pages/about.tsx
+
+## Other Notes
+
+The Committee Members are always displayed in the same order on the about page, which is the order mentioned in admin-dashboard/committee.md. If a certain Committee object can't be retreived, a placeholder Committee Member portrait will be displayed to maintain the same order.