anushka-bhowmick / convene

ConVene: Hackathon Platform

Welcome to CONVENE, your one-stop solution for hackathon enthusiasts and organizers to connect, explore, and engage with exciting hackathon events!

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Technology Stack
• Contributing
• License

Introduction

ConVene is a dynamic web platform designed to streamline the process of discovering, registering for, and managing hackathon events. Whether you're an eager participant looking for your next challenge or an enthusiastic organizer aiming to attract a diverse audience, ConVene has you covered.

Features

• User Authentication: Seamlessly log in using your Google account.
• Event Discovery: Browse and filter through a wide array of hackathon events.
• Event Creation: Organizers can easily create and manage their hackathon events.
• Real-time Updates: Manage event details and track registrations in real time.
• Engaging UI: Enjoy a visually appealing and responsive user interface.

Getting Started

Prerequisites

• Node.js and npm: Download here
• MongoDB: Download and installation guide

Installation

1. Clone the repository: git clone https://github.com/yourusername/convene.git
2. Navigate to the project directory: cd convene
3. Install dependencies: npm install
4. Rename .env.example to .env and configure your environment variables.
5. Start the server: npm start

Usage

1. Visit http://localhost:3000 in your web browser.
2. Log in using your Google account.
3. Browse and explore hackathon events.
4. Participate in events with a single click.
5. Organizers can create and manage events through their dashboard.

Technology Stack

• Frontend: HTML5, CSS3, JavaScript (React)
• Backend: Node.js, Express.js
• Database: MongoDB
• Authentication: Google OAuth
• Hosting: AWS or Heroku

Contributing

We welcome contributions from the community! If you find a bug, have an enhancement idea, or want to contribute code, please open an issue or create a pull request.

Please review our Contributing Guidelines before submitting a pull request.

License

This project is licensed under the MIT License.