Skip to content

README.md

Latest commit

 

History

History
212 lines (140 loc) · 3.63 KB

README.md

File metadata and controls

212 lines (140 loc) · 3.63 KB
Raw

🚀 Hackathon Management Platform

Empowering Students to Discover, Join, and Win Hackathons

A modern web platform that streamlines hackathon organization, team collaboration, project submissions, and participant management.

Tech TypeScript Vite License

📖 Overview

The Hackathon Management Platform is a centralized web application designed to simplify the entire hackathon lifecycle.

Students can discover hackathons, register individually or as teams, submit projects, and track competition progress, while organizers can efficiently create events, manage participants, review submissions, and announce winners through a single intuitive dashboard.

This project demonstrates scalable frontend architecture, reusable components, responsive UI design, and modern web development practices.

✨ Features

👨‍🎓 Student Portal

  • Browse upcoming hackathons
  • Register for events
  • Create or join teams
  • Submit projects
  • View submission status
  • Manage personal profile

🛠 Organizer Dashboard

  • Create and manage hackathons
  • Review participant registrations
  • Manage teams
  • Evaluate project submissions
  • Publish announcements
  • Track event statistics

💡 Platform Features

  • Responsive UI
  • Modern Dashboard
  • Secure Authentication
  • Reusable Components
  • Context API State Management
  • Fast Vite Development
  • Type-safe Development with TypeScript

🏗 Project Structure

.
├── components/
├── pages/
├── context/
├── hooks/
├── services/
├── constants.tsx
├── App.tsx
├── index.tsx
└── vite.config.ts

🛠 Tech Stack

Technology Purpose
React Frontend Framework
TypeScript Type Safety
Vite Build Tool
Context API State Management
CSS Styling
Gemini API AI Features

🚀 Getting Started

Prerequisites

  • Node.js (v18 or later)
  • npm

Installation

Clone the repository

git clone https://github.com/yourusername/hackathon-management-platform.git

Navigate into the project

cd hackathon-management-platform

Install dependencies

npm install

Create an environment file

GEMINI_API_KEY=your_api_key_here

Start the development server

npm run dev

The application will be available at:

http://localhost:5173

📂 Environment Variables

Create a file named:

.env.local

Add your Gemini API key:

GEMINI_API_KEY=YOUR_GEMINI_API_KEY

🎯 Future Enhancements

  • Authentication with Firebase/Auth0
  • Real-time notifications
  • Live leaderboard
  • AI-powered project evaluation
  • Certificate generation
  • Payment integration
  • Admin analytics dashboard
  • Email notifications

📸 Screenshots

Add screenshots of the homepage, dashboard, registration page, and project submission interface here.

🤝 Contributing

Contributions are welcome!

  1. Fork the repository
  2. Create your feature branch
git checkout -b feature/AmazingFeature
  1. Commit your changes
git commit -m "Add AmazingFeature"
  1. Push to the branch
git push origin feature/AmazingFeature
  1. Open a Pull Request

📜 License

This project is licensed under the MIT License.

⭐ If you found this project useful, consider giving it a star!