Synergy

Welcome to Synergy – your ultimate platform to find the perfect hackathon teammates and elevate your projects to new heights!

Table of Contents

• Synergy
  • Table of Contents
  • Introduction
  • Mission & Vision
  • Features
    • Home (Swiping)
    • Profiles
    • Teams
    • Hackathons
    • Direct Messages (DMs)
    • Profile Management
    • App Settings
  • Design
  • Getting Started
    • Prerequisites
    • Installation
    • Running the Development Server
  • Milestones & Timeline
    • Milestones
    • Timeline
  • Technologies Used
  • Contributing
  • License

Introduction

Synergy is designed to revolutionize your hackathon experience by connecting you with like-minded developers, designers, and innovators. Whether you're looking to join a team or expand your network, Synergy makes it effortless to find the perfect partners for your next big project.

Check out our Figma Design for an in-depth look at our UI/UX design.

Mission & Vision

Mission: Make team-matching and hackathon finding easier for students.

Vision: Get everyone to use Synergy to find their teammates when they want to participate in a hackathon, fostering collaboration and innovation within the student community.

Features

Home (Swiping)

• Swipe Functionality: Swipe on other student profiles (left to decline, right to accept).
• Multiple Hackathon Pages: Switch between different hackathon pages seamlessly.
• Filters: Home FYP filters including distance, university, number of hackathons attended, and more (premium filters available).

Profiles

• Demographics: Includes name, college/university, age, and number of hackathons attended.
• Projects: Display prompts along with links to DevPost or GitHub projects.
• Compatibility Score: (Premium feature) Indicates how well you match with other users.

Teams

• Team Management: Create and preview teams with unique names.
• Hackathon Details: View hackathon title, date, location, and website link.
• Profile Carousel: Swipe through team members' profiles.
• Search & Filter: Easily search and filter teams by title, date, and location.

Hackathons

• Browse Hackathons: Search and filter hackathons by title, date, and location.
• Infinite Scroll: View an endless list of hackathon previews.
• Add to Home FYP: Add hackathons to your personalized feed with a single click.

Direct Messages (DMs)

• Chat History: View all your DMs and engage in conversations.
• Profile Access: Click on profile headers to view full profiles.
• Team Invitations: Easily add users to your team via DMs.

Profile Management

• Edit Profile: Update demographics and prompts.
• Preview Profile: View your profile as other users see it.
• Advanced Filters: (Premium) Access additional filtering options based on compatibility and skills.

App Settings

• Customization: Tailor app settings to your preferences effortlessly.

Design

Our design philosophy focuses on a clean and intuitive user interface, ensuring a seamless experience for all users. We prioritize accessibility and responsiveness to cater to a diverse student population.

• Logo & Branding: Consistent logo and color schemes inspired by our Figma Designs.
• User Experience: Streamlined navigation and interactive elements to enhance user engagement.

Getting Started

Follow these instructions to set up and run Synergy locally on your machine.

Prerequisites

• Node.js (v14 or later)
• npm or yarn

Installation

1. Clone the Repository:

   git clone https://github.com/your-username/synergy.git
   cd synergy

2. Install Dependencies:

   Using npm:

   npm install

   Or using yarn:

   yarn install

Running the Development Server

Start the development server with one of the following commands:

Using npm:

npm run dev

Or using yarn:

yarn dev

Open http://localhost:3000 in your browser to see Synergy in action. The page will automatically reload as you make changes to the code.

Milestones & Timeline

Milestones

• B2B with MLH: Establish partnerships with Major League Hacking for broader reach.
• Premium Student Membership: Introduce premium features for enhanced user experience.

Timeline

• Wireframe: 10/30/24
• UI Design: 11/03/24
• Landing Page (Mailing List): 10/30/24
• Alpha 1.0 Version: 12/01/24
• Beta 1.1 Version: 01/01/25

Technologies Used

• Next.js: A React framework for building fast and scalable web applications.
• React: A JavaScript library for building user interfaces.
• TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.
• Framer Motion: A library for animations and gestures.
• Tailwind CSS: A utility-first CSS framework for rapid UI development.
• Radix UI: Low-level, accessible UI components for building high-quality design systems.
• React Hot Toast: A lightweight and customizable toast notification library.
• React Parallax Tilt: A tilting effect library for React components.
• Class Variance Authority: Manage complex className logic with ease.
• Lucide React: A set of beautiful, customizable icons.

Contributing

Contributions are welcome! If you have suggestions or improvements, feel free to open an issue or submit a pull request.

1. Fork the Repository

2. Create a Feature Branch

   git checkout -b feature/YourFeature

3. Commit Your Changes

   git commit -m "Add some feature"

4. Push to the Branch

   git push origin feature/YourFeature

5. Open a Pull Request

License

This project is licensed under the MIT License.

ro

---

Made with ❤️ by the Synergy Team