Merge pull request #172 from umdevclub/chore/typeSimplification

FawazBinSaleem · web-flow · commit de5a45d3b16c · 2026-03-15T14:42:22.000-05:00
chore!: Refactor types into separate folder
diff --git a/README.md b/README.md
@@ -45,4 +45,5 @@ So you don't need to worry about deployment of your code: As long as your change
 
 ## Contributing
 
+Thank you for considering contributing to the .devClub website.
 Please read the [Contributing Guide](CONTRIBUTING.md) before opening a pull request.
diff --git a/src/components/PeopleList.tsx b/src/components/PeopleList.tsx
@@ -15,7 +15,7 @@ import Select from "@mui/material/Select";
 import MenuItem from "@mui/material/MenuItem";
 
 import teamConfig from "@/resources/data/teamConfig";
-import { ITeamMember } from "@/resources/data/types";
+import { ITeamMember } from "@/types/types";
 
 function PersonCard({ personData }: { personData: ITeamMember }) {
   return (
diff --git a/src/components/championsList.tsx b/src/components/championsList.tsx
@@ -1,4 +1,4 @@
-import { IChampion } from "@/resources/data/types";
+import { IChampion } from "@/types/types";
 import "@/styles/PeopleList.scss";
 
 import Box from "@mui/material/Box";
diff --git a/src/resources/data/champions.ts b/src/resources/data/champions.ts
@@ -2,7 +2,7 @@ import graham from "@/resources/images/champions/graham.jpg";
 import joshua from "@/resources/images/champions/joshua.jpg";
 import brooklynn from "@/resources/images/champions/brooklynn.png";
 import jacob from "@/resources/images/champions/jacob.jpg";
-import { IChampion } from "./types";
+import { IChampion } from "@/types/team";
 
 const champions: IChampion[] = [
   {
diff --git a/src/resources/data/devHacksArchive/HackathonYearSponsors.tsx b/src/resources/data/devHacksArchive/HackathonYearSponsors.tsx
@@ -42,17 +42,11 @@ import Ubisoft2023 from "@/resources/images/devhacks/2023/devHacksSponsors/Ubiso
 import GreenUmbrella from "@/resources/images/devhacks/2023/devHacksSponsors/greenUmbrella.webp";
 import PayWorks from "@/resources/images/devhacks/2023/devHacksSponsors/payWorks.jpg";
 
-type HackathonYearSponsorsProps = { year: string | number };
-
-type Tier =
-  | "platinum"
-  | "gold"
-  | "silver"
-  | "bronze"
-  | "inkind"
-  | "schoolSponsor"; //size not implemented in devHacksSponsors.scss
-type Sponsor = { name: string; logo: string };
-type YearSponsors = Partial<Record<Tier, Sponsor[]>>;
+import type {
+  HackathonYearSponsorsProps,
+  Tier,
+  YearSponsors,
+} from "@/types/hackathon/sponsors";
 
 const TIER_LABEL: Record<Tier, string> = {
   platinum: "Platinum",
diff --git a/src/resources/data/events.ts b/src/resources/data/events.ts
@@ -1,4 +1,4 @@
-import type { EventData } from "./types";
+import type { EventData } from "@/types/events";
 import workshop from "@/resources/images/events/workshop.jpg";
 import devgames from "@/resources/images/events/devgames.jpg";
 import battlesnake from "@/resources/images/events/battlesnakes.jpg";
@@ -12,9 +12,8 @@ import labtours from "@/resources/images/events/Labtours.jpg";
 import codingKickoff from "@/resources/images/events/Coding Kickoff.png";
 
 //add upcoming image imports here
-import devhacks2026 from "@/resources/images/devhacks/2026/devhacks2026.png";
 
-export { TERMS_ORDER } from "./types";
+export { TERMS_ORDER } from "@/types/events";
 
 //if you want to add an upcoming event
 //add the fields: upcomingTitle, upcomingDescription, upcomingImage,location, date in the format 026-01-13T18:00:00 and rsvp to the relevant event object below
diff --git a/src/resources/data/forms.ts b/src/resources/data/forms.ts
diff --git a/src/resources/data/hackathonInfoConfig.ts b/src/resources/data/hackathonInfoConfig.ts
@@ -1,4 +1,4 @@
-import { HackathonInfo } from "./types";
+import { HackathonInfo } from "../../types/types";
 
 const hackathonInfoConfig: HackathonInfo = {
   "2026": {
diff --git a/src/resources/data/hackathonThemeConfig.ts b/src/resources/data/hackathonThemeConfig.ts
@@ -1,5 +1,5 @@
 import { hexToRgb } from "@mui/material";
-import { HackathonTheme } from "./types";
+import { HackathonTheme } from "../../types/types";
 
 const hackathonThemeConfig: HackathonTheme = {
   "2026": [
diff --git a/src/resources/data/hackathonWinners.ts b/src/resources/data/hackathonWinners.ts
@@ -1,9 +1,6 @@
-export type HackathonWinner = {
-  prizeIndex: number;
-  projectName: string;
-  teamMembers: string[];
-  projectUrl?: string;
-};
+import { HackathonWinner } from "@/types/hackathon/winner";
+
+//prize index is the prize category index from its respective year
 
 const hackathonWinners: Record<string, HackathonWinner[]> = {
   "2026": [
diff --git a/src/resources/data/teamConfig.ts b/src/resources/data/teamConfig.ts
@@ -1,4 +1,4 @@
-import { ITeam } from "./types";
+import { ITeam } from "@/types/team";
 
 //Please limit social medias to 3 per exec
 const teamConfig: ITeam = {
diff --git a/src/resources/data/types.ts b/src/resources/data/types.ts
diff --git a/src/resources/images/clubs/logo-cusec.svg b/src/resources/images/clubs/logo-cusec.svg
diff --git a/src/routes/Events.tsx b/src/routes/Events.tsx
@@ -1,6 +1,6 @@
 import React, { useMemo, useState } from "react";
 import { EVENTS } from "@/resources/data/events";
-import type { Term } from "@/resources/data/types";
+import type { Term } from "@/types/events";
 import "@/styles/Events.scss";
 
 const TERMS: Term[] = ["Summer", "Fall", "Winter"];
diff --git a/src/routes/FormRedirect.tsx b/src/routes/FormRedirect.tsx
diff --git a/src/routes/hackathon/Hackathon.tsx b/src/routes/hackathon/Hackathon.tsx
@@ -162,7 +162,7 @@ function Hackathon() {
       {/* <h1 className="hackathon-sponsors heading">Our Sponsors</h1>
       <HackathonYearSponsors year={2026} /> */}
 
-      <h1 className="hackathon-sponsors heading">Event Pictures</h1>
+      <h1 className="hackathon-sponsors heading">Pictures</h1>
       <GalleryScroller images={picturesGeneralImages} />
 
       <h1 className="hackathon-sponsors heading">Go Back in Time</h1>
diff --git a/src/routes/hackathon/HackathonArchive.tsx b/src/routes/hackathon/HackathonArchive.tsx
@@ -7,7 +7,7 @@ import HackathonWinners from "@/routes/hackathon/hackathonWinners";
 import HackathonYearPictures from "@/resources/data/devHacksArchive/HackathonYearPictures";
 import HackathonYearSponsors from "@/resources/data/devHacksArchive/HackathonYearSponsors";
 
-import { HackathonInfo } from "@/resources/data/types";
+import { HackathonInfo } from "@/types/hackathon/hackathon";
 
 function HackathonArchive() {
   const { data } = useLoaderData() as HackathonInfo;
diff --git a/src/routes/hackathon/HackathonArchiveCards.ts b/src/routes/hackathon/HackathonArchiveCards.ts
@@ -4,13 +4,7 @@ import scheduleBg2026 from "@/resources/images/devhacks/2026/schedule_bg_2026.pn
 
 import scheduleBg2023 from "@/resources/images/devhacks/2023/devhacks2023-schedule-bg.png";
 
-export type HackathonArchiveCard = {
-  year: number;
-  title: string;
-  subtitle: string;
-  route: string;
-  image: string;
-};
+import { HackathonArchiveCard } from "@/types/hackathon/hackathon";
 
 export const HackathonArchiveCards: HackathonArchiveCard[] = [
   {
diff --git a/src/routes/hackathon/HackathonSchedule.tsx b/src/routes/hackathon/HackathonSchedule.tsx
@@ -4,7 +4,7 @@ import Devhacks2024Schedule from "@/resources/data/devHacksArchive/devHacks2024/
 import Devhacks2025Schedule from "@/resources/data/devHacksArchive/devHacks2025/Schedule2025";
 import Devhacks2026Schedule from "@/resources/data/devHacksArchive/devHacks2026/Schedule2026";
 
-import { HackathonConfig } from "@/resources/data/types";
+import { HackathonInfo } from "@/types/hackathon/hackathon";
 
 const scheduleMap = {
   "2024": Devhacks2024Schedule,
@@ -15,7 +15,7 @@ const scheduleMap = {
 type YearKey = keyof typeof scheduleMap;
 
 function HackathonSchedule() {
-  const { data } = useLoaderData() as HackathonConfig;
+  const { data } = useLoaderData() as HackathonInfo;
 
   const ScheduleComponent = scheduleMap[data.year as YearKey];
 
diff --git a/src/routes/hackathon/HackathonThemes.tsx b/src/routes/hackathon/HackathonThemes.tsx
@@ -3,7 +3,7 @@ import { useLoaderData } from "react-router-dom";
 import { memo, useMemo, ReactNode } from "react";
 
 import "@/styles/PrizeCategories.scss";
-import { HackathonTheme } from "@/resources/data/types";
+import { HackathonTheme } from "@/types/types";
 
 type ThemeDetail = {
   header?: string;
diff --git a/src/types/events.ts b/src/types/events.ts
@@ -0,0 +1,19 @@
+export type Term = "Summer" | "Fall" | "Winter";
+
+export interface EventData {
+  id: string;
+  title: string;
+  term?: Term[];
+  description: string;
+  image: string;
+  path?: string;
+  recurring?: boolean;
+  //use this for upcoming events in Events.ts, can be array or just string to setup multiple events of the same thing
+  upcomingTitle?: string | string[];
+  upcomingDescription?: string | string[];
+  upcomingImage?: string | string[];
+  date?: string | string[];
+  location?: string | string[];
+  rsvp?: string | string[];
+}
+export const TERMS_ORDER: Term[] = ["Summer", "Fall", "Winter"];
diff --git a/src/types/hackathon/hackathon.ts b/src/types/hackathon/hackathon.ts
@@ -0,0 +1,34 @@
+export type HackathonTheme = {
+  [key: string]: {
+    title: string;
+    description: string | string[];
+    details?: {
+      header?: string;
+      content?: string[];
+    }[];
+    body?: string;
+  }[];
+};
+
+export type HackathonInfo = {
+  [key: string]: {
+    year: string;
+    title: string;
+    subtitle: string;
+    location: string;
+    date: string;
+    description: string;
+    links: {
+      text: string;
+      path: string;
+    }[];
+  };
+};
+
+export type HackathonArchiveCard = {
+  year: number;
+  title: string;
+  subtitle: string;
+  route: string;
+  image: string;
+};
diff --git a/src/types/hackathon/sponsors.ts b/src/types/hackathon/sponsors.ts
@@ -0,0 +1,18 @@
+export type Tier =
+  | "platinum"
+  | "gold"
+  | "silver"
+  | "bronze"
+  | "inkind"
+  | "schoolSponsor";
+
+export type Sponsor = {
+  name: string;
+  logo: string;
+};
+
+export type YearSponsors = Partial<Record<Tier, Sponsor[]>>;
+
+export type HackathonYearSponsorsProps = {
+  year: string | number;
+};
diff --git a/src/types/hackathon/winner.ts b/src/types/hackathon/winner.ts
@@ -0,0 +1,6 @@
+export type HackathonWinner = {
+  prizeIndex: number;
+  projectName: string;
+  teamMembers: string[];
+  projectUrl?: string;
+};
diff --git a/src/types/team.ts b/src/types/team.ts
@@ -0,0 +1,24 @@
+export interface ITeamMember {
+  firstName: string;
+  middleName?: string;
+  lastName: string;
+  role: string;
+  image: string;
+  linkedin?: string;
+  github?: string;
+  website?: string;
+  instagram?: string;
+  discord?: string;
+}
+
+export interface ITeam {
+  [year: string]: ITeamMember[];
+}
+
+//devchamp winners
+export interface IChampion {
+  name: string;
+  challenge: string;
+  image: string;
+  bio: string;
+}

Original file line number	Diff line number	Diff line change
`@@ -45,4 +45,5 @@ So you don't need to worry about deployment of your code: As long as your change`
`45`	`45`
`46`	`46`	`## Contributing`
`47`	`47`
	`48`	`+Thank you for considering contributing to the .devClub website.`
`48`	`49`	`Please read the [Contributing Guide](CONTRIBUTING.md) before opening a pull request.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { IChampion } from "@/resources/data/types";`
	`1`	`+import { IChampion } from "@/types/types";`
`2`	`2`	`import "@/styles/PeopleList.scss";`
`3`	`3`
`4`	`4`	`import Box from "@mui/material/Box";`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import graham from "@/resources/images/champions/graham.jpg";`
`2`	`2`	`import joshua from "@/resources/images/champions/joshua.jpg";`
`3`	`3`	`import brooklynn from "@/resources/images/champions/brooklynn.png";`
`4`	`4`	`import jacob from "@/resources/images/champions/jacob.jpg";`
`5`		`-import { IChampion } from "./types";`
	`5`	`+import { IChampion } from "@/types/team";`
`6`	`6`
`7`	`7`	`const champions: IChampion[] = [`
`8`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { HackathonInfo } from "./types";`
	`1`	`+import { HackathonInfo } from "../../types/types";`
`2`	`2`
`3`	`3`	`const hackathonInfoConfig: HackathonInfo = {`
`4`	`4`	`"2026": {`