Skip to content

README.md

Latest commit

 

History

History
152 lines (103 loc) · 3.84 KB

README.md

File metadata and controls

152 lines (103 loc) · 3.84 KB

🚀 DevMatchups

The ultimate platform to find teammates for hackathons — globally 🌍

GSSoC'25 Banner

CodeRabbit Pull Request Reviews

📌 Overview

DevMatchups is a web platform designed to connect developers, designers, and enthusiasts from around the world to form hackathon teams. Whether you're searching for teammates with complementary skills or exploring upcoming events, this platform makes collaboration easy and effective.

✨ Features

👤 User & Team Features

  • User registration and authentication
  • Developer profile creation and management
  • Team formation with matchmaking

🎯 Hackathon Discovery

  • Explore upcoming hackathon listings
  • Advanced filters and search options
  • Personalized match recommendations

💅 UI/UX Enhancements

  • Back-to-top button across all pages
  • Integrated chatbot assistant
  • Icon upgrades using Lucide React
  • Redesigned headers for visual consistency

🛠️ Tech Stack

Tech Stack

  • UI Libraries: Shadcn UI, Aceternity UI, Tailwind CSS, Framer Motion

🚀 Getting Started

🔄 Clone the Repository

git clone https://github.com/harsh3dev/DevMatchups.git
cd DevMatchups

📦 Install Dependencies

npm install
# or
pnpm install
# or
bun install

🐳 Run with Docker (optional)

docker-compose up --build

🧪 Start the Development Server

npm run dev
# or
pnpm run dev
# or
bun dev

Visit http://localhost:3000 in your browser.

🗂️ Project Structure

  • app/ — Routing and main page structure
  • components/ — Reusable UI components
  • hooks/ — Custom React hooks
  • lib/ — Utility libraries and helpers
  • prisma/ — Database schema and migrations
  • public/ — Static assets (images, icons, etc.)
  • __tests__/ — Unit and integration tests
  • .github/ — GitHub Actions and workflow configs
  • Actions/ — CI/CD configurations

🤝 Contributing

We welcome contributions! Here’s a quick guide to get started:

# Fork the repository

# Create your feature branch
git checkout -b feature/your-feature

# Commit your changes
git commit -m "Add: your feature"

# Push to GitHub
git push origin feature/your-feature

Then, open a pull request 🚀

Please ensure your code adheres to the project style and includes appropriate test coverage. See CONTRIBUTING.md and Code of Conduct for more info.

📬 Contact

👥 Project Contributors

A huge thanks to all contributors who made DevMatchups possible:

Project Contributers:

---

📝 License

This project is licensed under the MIT License.

Built with ☕️, 💻, and plenty of caffeine.
💡 *Pro tip: Your perfect team might be one pull request away.*