Skip to content

Repository files navigation

HUFS CodeFestival

CodeFestival

Welcome to the web frontend repository for the 2024-2025 Hankuk University of Foreign Studies (HUFS) Code Festival. This repository includes the code for the landing page, competition archive, and other festival features.

Features

  • Landing Page for Registration: A dedicated page for participants to sign up for the Code Festival.
  • Competition Details: Detailed event information, such as schedules, categories, and judging criteria.
  • FAQ Page: Answers to common questions to help participants navigate the event smoothly.
  • Gallery: A section showcasing event highlights, previous competitions, and participant achievements, providing a glimpse into the Code Festival experience.

These pages leverage Next.js's Intercepting Routes and Parallel Routes, allowing for greater flexibility in navigation and page rendering. This architecture ensures that users experience seamless transitions and efficient data loading across the platform.

Tech Stack

Category Stack
common TypeScript ESLint Prettier Pnpm
frontend React Next.js Vanilla Extract Three.js
CI GitHub Actions
deployment Vercel

Getting Started

Project Setup

  1. Clone the repository:
   git clone https://github.com/GDGHUFS/CodeFestival-Web.git
  1. Install the dependencies:

if you are not installed pnpm, install it first: npm install -g pnpm

   pnpm install
  1. Start the development server:
  pnpm dev

Competition Setup

Competition metadata and registration periods are managed by the CodeFestival API instead of a hard-coded frontend constant.

  1. Create an MDX file in content/histories. Use the competition edition as the filename, such as 7.mdx.
  2. Add the competition details to the MDX file and verify that /festival/{edition} renders correctly.
  3. Open /admin, authenticate with an administrator account, and create a competition using the same edition.
  4. Configure its title, privacy policy, registration period, event date, and active status.

The active competition is automatically reflected in the landing page, header, and application page. Activating a new competition deactivates the previously active competition, while its MDX page remains available as part of the competition history.

FAQ Page Content

If you need to update the content of the FAQ page, update the src/constants/faq.ts file.

License

This project is distributed under the MIT License. For more information, see the LICENSE file.

Contact

If you have any questions, feel free to reach out via Issues or contact me directly at [email protected].

About

πŸš€ Official Website for the HUFS CodeFestival

Resources

Stars

Watchers

Forks

Used by

Contributors

Languages