Skip to content

feat: standardize code comments across codebase #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OSEH-svg merged 2 commits into from
Mar 30, 2026
Merged

feat: standardize code comments across codebase #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf1276a
...
gracekenn Mar 30, 2026
66ce62c
feat: standardize code comments across codebase
gracekenn Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 129 additions & 28 deletions apps/web/components/events/create-event-form.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,35 @@
"use client";

import { useState } from "react";
import { Button } from "@/components/ui/button";
import Image from "next/image";
import { useState } from "react";

/**
* Form data structure for creating a new event
* @interface EventFormData
*/
export type EventFormData = {
/** Title of the event */
title: string;
/** Start date in YYYY-MM-DD format */
startDate: string;
/** Start time in HH:MM format */
startTime: string;
/** End date in YYYY-MM-DD format */
endDate: string;
/** End time in HH:MM format */
endTime: string;
/** Timezone identifier (e.g., "GMT+00:00 UTC") */
timezone: string;
/** Physical or virtual location */
location: string;
/** Detailed description of the event */
description: string;
/** Event visibility setting */
visibility: "Public" | "Private";
/** Maximum number of attendees */
capacity: string;
/** Ticket price (empty string for free events) */
price: string;
};

Expand All @@ -32,12 +47,19 @@ const initialFormState: EventFormData = {
price: "",
};

/**
* CreateEventForm component for creating new events
*
* @returns React component that renders a form for creating events
*/
export default function CreateEventForm() {
const [formData, setFormData] = useState<EventFormData>(initialFormState);
const [locationMode, setLocationMode] = useState<"Virtual" | "Physical">("Physical");
const [locationMode, setLocationMode] = useState<"Virtual" | "Physical">(
"Physical",
);

const handleChange = (
e: React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement>
e: React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement>,
) => {
const { name, value } = e.target;

Expand Down Expand Up @@ -71,7 +93,8 @@ export default function CreateEventForm() {
const isSubmitDisabled = !formData.title.trim() || !formData.startDate.trim();

// Common Neubrutalist class for form controls
const neubrutalistInputClass = "w-full bg-white border border-gray-100 rounded-xl focus-within:border-black focus-within:border-2 focus-within:shadow-[4px_4px_0px_0px_rgba(0,0,0,1)] transition-all";
const neubrutalistInputClass =
"w-full bg-white border border-gray-100 rounded-xl focus-within:border-black focus-within:border-2 focus-within:shadow-[4px_4px_0px_0px_rgba(0,0,0,1)] transition-all";

return (
<div className="flex flex-col gap-6 w-full">
Expand All @@ -90,7 +113,9 @@ export default function CreateEventForm() {

{/* Date & Time Section */}
<div className="flex flex-col sm:flex-row gap-4">
<div className={`p-4 flex-1 flex flex-col gap-3 shadow-sm ${neubrutalistInputClass}`}>
<div
className={`p-4 flex-1 flex flex-col gap-3 shadow-sm ${neubrutalistInputClass}`}
>
<div className="flex items-center gap-4">
<span className="text-sm font-semibold w-12 flex items-center gap-2">
<span className="w-2 h-2 rounded-full bg-black block"></span>
Expand All @@ -114,7 +139,7 @@ export default function CreateEventForm() {
/>
</div>
<div className="flex items-center gap-4 relative">
<div className="absolute left-1 top-[-10px] w-px h-6 bg-dashed border-l border-dashed border-gray-300"></div>
<div className="absolute left-1 top-[-10px] w-px h-6 bg-dashed border-l border-dashed border-gray-300"></div>
<span className="text-sm font-semibold w-12 flex items-center gap-2">
<span className="w-2 h-2 rounded-full border-2 border-gray-300 block"></span>
End
Expand All @@ -137,7 +162,7 @@ export default function CreateEventForm() {
/>
</div>
</div>

<div className="bg-[#FFFBEA] rounded-xl p-4 shadow-sm w-full sm:w-auto min-w-[140px] flex items-center justify-between gap-4 border border-black shadow-[-2px_2px_0px_0px_rgba(0,0,0,1)]">
<div className="flex flex-col">
<span className="text-sm font-semibold">GMT+00:00</span>
Expand All @@ -151,38 +176,68 @@ export default function CreateEventForm() {

{/* Location Section */}
<div className={`p-4 shadow-sm ${neubrutalistInputClass}`}>
<label className="block text-sm font-semibold mb-3">Add Event Location</label>
<label className="block text-sm font-semibold mb-3">
Add Event Location
</label>
<div className="flex items-center gap-4">
<input
type="text"
name="location"
value={formData.location}
onChange={handleChange}
placeholder={locationMode === "Virtual" ? "Virtual meeting link" : "Offline location or map pin"}
placeholder={
locationMode === "Virtual"
? "Virtual meeting link"
: "Offline location or map pin"
}
className="flex-1 text-base font-medium bg-transparent outline-none placeholder:text-gray-300"
/>
<div className="flex gap-2">
<button
<button
type="button"
onClick={() => setLocationMode("Virtual")}
className={`w-10 h-10 rounded-full flex items-center justify-center transition-colors ${locationMode === "Virtual" ? "bg-black" : "bg-[#FAF9F6] hover:bg-gray-100"}`}
>
<Image src="/icons/video.svg" width={20} height={20} alt="Video" className={locationMode === "Virtual" ? "invert brightness-0" : "opacity-60"} />
<Image
src="/icons/video.svg"
width={20}
height={20}
alt="Video"
className={
locationMode === "Virtual"
? "invert brightness-0"
: "opacity-60"
}
/>
</button>
<button
<button
type="button"
onClick={() => setLocationMode("Physical")}
className={`w-10 h-10 rounded-full flex items-center justify-center transition-colors ${locationMode === "Physical" ? "bg-black" : "bg-[#FAF9F6] hover:bg-gray-100"}`}
>
<Image src="/icons/location.svg" width={20} height={20} alt="Map" className={locationMode === "Physical" ? "invert brightness-0" : "opacity-60"} />
<Image
src="/icons/location.svg"
width={20}
height={20}
alt="Map"
className={
locationMode === "Physical"
? "invert brightness-0"
: "opacity-60"
}
/>
</button>
</div>
</div>
</div>

{/* Description Section */}
<div className={`p-4 shadow-sm min-h-[140px] flex flex-col ${neubrutalistInputClass}`}>
<label className="block text-sm font-semibold mb-3">Add Description</label>
<div
className={`p-4 shadow-sm min-h-[140px] flex flex-col ${neubrutalistInputClass}`}
>
<label className="block text-sm font-semibold mb-3">
Add Description
</label>
<div className="flex items-start gap-4 flex-1">
<textarea
name="description"
Expand All @@ -197,19 +252,27 @@ export default function CreateEventForm() {
className="flex-1 text-base font-medium bg-transparent outline-none placeholder:text-gray-300 resize-none overflow-hidden min-h-[80px]"
/>
<div className="w-10 h-10 rounded-full bg-[#FAF9F6] flex items-center justify-center shrink-0 mt-1">
<Image src="/icons/edit.svg" width={20} height={20} alt="Edit" className="opacity-60" />
<Image
src="/icons/edit.svg"
width={20}
height={20}
alt="Edit"
className="opacity-60"
/>
</div>
</div>
</div>

{/* Event Options Section */}
<div className="mt-4">
<h3 className="text-lg font-bold mb-4">Event Options</h3>

<div className="flex flex-col md:flex-row gap-4 mb-4">
{/* Visibility */}
<div className="bg-white rounded-xl p-4 shadow-sm flex-1 border border-gray-100">
<label className="block text-sm font-semibold mb-3">Event Visibility</label>
<label className="block text-sm font-semibold mb-3">
Event Visibility
</label>
<div className="flex bg-[#FAF9F6] p-1 rounded-xl w-full">
<button
type="button"
Expand All @@ -221,8 +284,18 @@ export default function CreateEventForm() {
}`}
>
Public
<div className={`w-6 h-6 rounded-full flex items-center justify-center ${formData.visibility === "Public" ? "bg-white border border-gray-100 shadow-sm" : "bg-white border border-gray-100 shadow-sm"} `}>
<Image src="/icons/megaphone.svg" width={14} height={14} alt="Megaphone" className={formData.visibility === "Public" ? "" : "opacity-40"} />
<div
className={`w-6 h-6 rounded-full flex items-center justify-center ${formData.visibility === "Public" ? "bg-white border border-gray-100 shadow-sm" : "bg-white border border-gray-100 shadow-sm"} `}
>
<Image
src="/icons/megaphone.svg"
width={14}
height={14}
alt="Megaphone"
className={
formData.visibility === "Public" ? "" : "opacity-40"
}
/>
</div>
</button>
<button
Expand All @@ -235,16 +308,28 @@ export default function CreateEventForm() {
}`}
>
Private
<div className={`w-6 h-6 rounded-full flex items-center justify-center ${formData.visibility === "Private" ? "bg-white border border-gray-100 shadow-sm" : "bg-white border border-gray-100 shadow-sm"} `}>
<Image src="/icons/lock.svg" width={12} height={12} alt="Lock" className={formData.visibility === "Private" ? "" : "opacity-40"} />
<div
className={`w-6 h-6 rounded-full flex items-center justify-center ${formData.visibility === "Private" ? "bg-white border border-gray-100 shadow-sm" : "bg-white border border-gray-100 shadow-sm"} `}
>
<Image
src="/icons/lock.svg"
width={12}
height={12}
alt="Lock"
className={
formData.visibility === "Private" ? "" : "opacity-40"
}
/>
</div>
</button>
</div>
</div>

{/* Capacity */}
<div className={`p-4 shadow-sm flex-1 ${neubrutalistInputClass}`}>
<label className="block text-sm font-semibold mb-3">Set Capacity</label>
<label className="block text-sm font-semibold mb-3">
Set Capacity
</label>
<div className="flex items-center justify-between">
<input
type="text"
Expand All @@ -255,15 +340,24 @@ export default function CreateEventForm() {
className="w-full text-base font-medium bg-transparent outline-none placeholder:text-gray-300"
/>
<div className="w-10 h-10 bg-[#FFFBEA] border border-black rounded-lg shadow-[-2px_2px_0px_0px_rgba(0,0,0,1)] flex items-center justify-center shrink-0">
<Image src="/icons/edit.svg" width={20} height={20} alt="Edit" />
<Image
src="/icons/edit.svg"
width={20}
height={20}
alt="Edit"
/>
</div>
</div>
</div>
</div>

{/* Ticket Price */}
<div className={`p-4 shadow-sm w-full md:w-[calc(50%-8px)] ${neubrutalistInputClass}`}>
<label className="block text-sm font-semibold mb-3">Ticket Price</label>
<div
className={`p-4 shadow-sm w-full md:w-[calc(50%-8px)] ${neubrutalistInputClass}`}
>
<label className="block text-sm font-semibold mb-3">
Ticket Price
</label>
<div className="flex items-center justify-between">
<input
type="text"
Expand All @@ -274,7 +368,12 @@ export default function CreateEventForm() {
className="w-full text-base font-medium bg-transparent outline-none placeholder:text-gray-300"
/>
<div className="w-10 h-10 bg-[#FFFBEA] border border-black rounded-lg shadow-[-2px_2px_0px_0px_rgba(0,0,0,1)] flex items-center justify-center shrink-0">
<Image src="/icons/ticket.svg" width={20} height={20} alt="Ticket" />
<Image
src="/icons/ticket.svg"
width={20}
height={20}
alt="Ticket"
/>
</div>
</div>
</div>
Expand All @@ -297,7 +396,9 @@ export default function CreateEventForm() {
backgroundColor="bg-[#FFD233]"
textColor="text-black"
className={`w-full sm:w-auto ${
isSubmitDisabled ? "opacity-50 cursor-not-allowed hover:translate-x-0 hover:translate-y-0 active:translate-x-0 active:translate-y-0" : ""
isSubmitDisabled
? "opacity-50 cursor-not-allowed hover:translate-x-0 hover:translate-y-0 active:translate-x-0 active:translate-y-0"
: ""
}`}
>
Create Event <span className="ml-1 text-lg">↗</span>
Expand Down
16 changes: 16 additions & 0 deletions apps/web/components/events/event-card.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,31 @@
import Image from "next/image";
import Link from "next/link";

/**
* Props for the EventCard component
* @interface EventCardProps
*/
type EventCardProps = {
/** Unique identifier for the event */
id: number;
/** Title/name of the event */
title: string;
/** Formatted date string of the event */
date: string;
/** Location where the event takes place */
location: string;
/** Price of the event (string to support "Free" values) */
price: string;
/** URL to the event's cover image */
imageUrl: string;
};

/**
* EventCard component that displays event information in a card format
*
* @param props - EventCardProps containing event information
* @returns React component that renders a clickable event card
*/
export function EventCard({
id,
title,
Expand Down
Loading
Loading