An open API service indexing awesome lists of open source software.

https://github.com/isodevmate/final--year-project

๐ŸŽ‰ ComfyBase is a comprehensive Smart event management platform designed to simplify event organization, enhance attendee engagement, and provide seamless event experiences. It integrates cutting-edge technology to offer identity verification, live streaming, interactive note-taking, media sharing,and an awards system to recognize well-put notes
https://github.com/isodevmate/final--year-project

award-system livestreaming media-upload mongodb mongoose nodejs notifications qrcode react tailwindcss webrtc wss

Last synced: 3 months ago
JSON representation

๐ŸŽ‰ ComfyBase is a comprehensive Smart event management platform designed to simplify event organization, enhance attendee engagement, and provide seamless event experiences. It integrates cutting-edge technology to offer identity verification, live streaming, interactive note-taking, media sharing,and an awards system to recognize well-put notes

Awesome Lists containing this project

README

        

# ComfyBase Event Management System ๐ŸŽซ

[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![React](https://img.shields.io/badge/React-v19.0.0-blue.svg)](https://reactjs.org/)
[![Node.js](https://img.shields.io/badge/Node.js-v18+-green.svg)](https://nodejs.org/)
[![MongoDB](https://img.shields.io/badge/MongoDB-v8.10.1-green.svg)](https://www.mongodb.com/)
[![TypeScript](https://img.shields.io/badge/TypeScript-v5.7.2-blue.svg)](https://www.typescriptlang.org/)

A modern event management platform for seamless attendee engagement and interactive experiences.

[Features](#features) โ€ข [Installation](#installation) โ€ข [Tech Stack](#tech-stack) โ€ข [Architecture](#architecture) โ€ข [Contributing](#contributing)

## ๐ŸŒŸ Features

- **Real-time Event Interactions**
- Live streaming capabilities for premium users
- Interactive note-taking with multimedia support
- QR code-based identity verification

- **Cross-Platform Accessibility**
- Seamless media uploads
- Content sharing across platforms
- Responsive design for all devices

- **Enhanced Attendee Experience**
- Interactive session tracking
- Multimedia-enhanced note-taking
- Real-time notifications

## ๐Ÿš€ Installation

### Prerequisites

- Node.js (v18 or higher)
- MongoDB (v8.10.1 or higher)
- npm or yarn

### Frontend Setup

```bash
# Clone the repository
git clone https://github.com/your-username/comfybase.git

# Navigate to frontend directory
cd comfybase/frontend

# Install dependencies
npm install

# Start development server
npm run dev
```

### Backend Setup

```bash
# Navigate to backend directory
cd ../backend

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env

# Start server
npm run dev
```

## ๐Ÿ› ๏ธ Tech Stack

### Frontend
- React 19.0.0
- TailwindCSS 4.0.8
- Material UI 6.4.5
- React Router 7.2.0
- TypeScript 5.7.2
- Framer Motion 12.4.7
- wss

### Backend
- Node.js with Express
- MongoDB 8.10.1
- Firebase Admin 13.1.0
- Stripe Integration
- WebRTC for real-time communication

### Development Tools
- Vite 6.1.0
- ESLint 9.19.0
- TypeScript ESLint
- Jest for testing

## ๐Ÿ—๏ธ Architecture

```mermaid
graph TD
A[Client Layer - React] --> B[API Layer - Node.js/Express]
B --> C[Database Layer - MongoDB]
B --> D[Storage Layer - Firebase]
B --> E[Payment Processing - Stripe]
B --> F[Real-time Communication - WebRTC]
```

## ๐Ÿ” Environment Variables

Create a `.env` file in the backend directory:

```env
MONGODB_URI=your_mongodb_uri
FIREBASE_CONFIG=your_firebase_config
STRIPE_SECRET_KEY=your_stripe_secret
JWT_SECRET=your_jwt_secret
```

## ๐Ÿ“ API Documentation

### Authentication Endpoints
```
POST /api/auth/login
POST /api/auth/register
GET /api/auth/verify
```

### Event Management
```
GET /api/events
POST /api/events
PUT /api/events/:id
DELETE /api/events/:id
```

### User Interaction
```
POST /api/notes
GET /api/streams
POST /api/media/upload
```

## ๐Ÿงช Testing

```bash
# Run frontend tests
cd frontend && npm test

# Run backend tests
cd backend && npm test

# Run e2e tests
npm run test:e2e
```

## ๐Ÿค Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## ๐Ÿ“œ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## ๐Ÿ‘ฅ Team

- Barack Oduor Ouma - Project Lead & Software Engineer

## ๐Ÿ™ Acknowledgments

- Dr. Kennedy Siika - Project Supervisor
- Kenyatta University - Department of Computing and Information Sciences