Skip to content

Praneeth-2602/Weekend_Knocks

Repository files navigation

Weekend Knocks 🎮

Weekend Knocks is a vibrant eSports community designed for passionate gamers and aspiring professionals pursuing undergraduate studies across India. The platform focuses on hosting inter-college tournaments, team matchmaking, and fostering collaboration, all while creating a fun, engaging Saturday night experience.

Features 🚀

  • Inter-College Tournaments: Compete with teams from various colleges.
  • Team Matchmaking: Find and form teams with like-minded gamers.
  • Leaderboards: Track performance and rankings in real-time.
  • Live Streams: Watch matches live and share the excitement.
  • Community Forums: Discuss strategies, share highlights, and connect with fellow gamers.
  • Exclusive Events: Participate in polls, special events, and challenges.

Tech Stack 🛠️

  • Frontend: Next.js, Tailwind CSS
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Community: Discord Integration

Getting Started 🧑‍💻

Prerequisites

Ensure you have the following installed:

  • Node.js (v16.x or above)
  • MongoDB
  • A text editor or IDE (e.g., VS Code)

Installation

  1. Clone the Repository:

    git clone https://github.com/your-username/weekend-knocks.git  
    cd weekend-knocks  
  2. Install Dependencies:

    npm install  
  3. Set Up Environment Variables:
    Create a .env file in the root directory with the following:

    MONGO_URI=<Your MongoDB Connection String>  
    PORT=5000  
    JWT_SECRET=<Your Secret Key>  
  4. Run the Development Server:

    npm run dev  
  5. Open your browser and go to http://localhost:5000.


Contribution Guidelines 🤝

We welcome contributions to Weekend Knocks! Here's how you can get started:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature-name  
  3. Make your changes and commit them:
    git commit -m "Add your message here"  
  4. Push to your fork and create a pull request.

Before contributing, please take a moment to read our Contributing Guidelines.

Code of Conduct

Please read our Code of Conduct to understand our community expectations.


Project Roadmap 🗺️

Phase 1: Core Features

  • Inter-college team matchmaking
  • Tournament hosting module
  • Leaderboards and performance tracking

Phase 2: Community Engagement

  • Discord bot integration
  • Match highlights and event reports

Phase 3: Advanced Features

  • AI-driven team recommendations
  • Cross-platform app support

Community and Support 💬

Join our community on Discord: Weekend Knocks Discord

If you have any questions or suggestions, feel free to open an issue.


Contributors

A heartfelt thanks to our wonderful contributors


Acknowledgments

Thanks to Social Winter of Code (SWOC) for recognizing and supporting this project! 🙌

About

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors