Skip to content

Latest commit

 

History

History
171 lines (134 loc) · 4.57 KB

README.md

File metadata and controls

171 lines (134 loc) · 4.57 KB

VideoShare Platform

A full-stack video sharing platform built with Next.js and Firebase. Users can upload, share, and interact with videos through a modern, responsive interface. Features include real-time view counting, comments, and likes/dislikes, creating an engaging social media experience.

Features

  • User Authentication

    • Seamless Google sign-in integration
    • Protected routes for authenticated users
    • Personalized user profiles displaying uploaded videos

  • Video Management

    • Direct video upload with automatic thumbnail generation
    • Accurate real-time view counting
    • Like/Dislike system with instant updates
    • Interactive comment section with real-time updates
    • Custom video player interface

  • Search & Discovery

    • Instant video search functionality
    • Multiple sorting options (views/likes/date)
    • User profile filtering

Getting Started

Prerequisites

  • Node.js v14 or later
  • Firebase project configured with:
    • Authentication (Google provider enabled)
    • Firestore Database
    • Storage
    • Service Account credentials

Installation

  1. Clone and set up:
# Clone the repository
git clone https://github.com/yourusername/video-sharing-platform.git
cd video-sharing-platform

# Install all dependencies from root directory
npm run dev

  1. Set up Firebase:

    • Create a new Firebase project at Firebase Console
    • Enable Authentication with Google provider
    • Create a Firestore database
    • Set up Firebase Storage
    • Generate a service account key from Project Settings > Service Accounts

  2. Configure environment variables:

Create .env.local in root directory:

NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_project.appspot.com
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id

Create .env in backend directory:

PORT=3001
FIREBASE_PROJECT_ID=your_project_id
FIREBASE_CLIENT_EMAIL=your_service_account_email
FIREBASE_PRIVATE_KEY=your_private_key
FIREBASE_STORAGE_BUCKET=your_storage_bucket

Running Locally

Run the development server:

npm run dev

This starts both frontend and backend servers:

Technical Architecture

Frontend

  • Next.js 13 with App Router
  • TypeScript for type safety
  • Tailwind CSS for styling
  • Firebase Client SDK for authentication and storage

Backend

  • Express.js server
  • Firebase Admin SDK
  • TypeScript
  • Real-time database listeners

Database & Storage

  • Firestore for storing:
    • User profiles
    • Video metadata
    • Comments
    • Like/dislike data
  • Firebase Storage for video files and thumbnails

Core Features Explained

Video Upload Process

  1. User uploads video file
  2. Automatic thumbnail generation from video
  3. File storage in Firebase Storage
  4. Metadata storage in Firestore

View Counting System

  • Real-time view updates
  • View count increments on each video load
  • Firestore transactions for accuracy

Comment System

  • Real-time comment updates
  • Nested comment structure
  • User information integration

Project Structure

├── backend/                  # Express server
│   ├── src/
│   │   ├── config/          # Firebase admin config
│   │   ├── routes/          # API routes
│   │   └── server.ts        # Server entry
│   └── scripts/             # Utility scripts
├── src/                     # Frontend source
│   ├── app/                 # Next.js app directory
│   ├── components/          # React components
│   ├── contexts/            # React contexts
│   ├── lib/                 # Firebase config
│   └── utils/               # Utility functions
└── public/                  # Static files

Development

Available Scripts

# Run development server
npm run dev

# Run backend only
cd backend
npm run dev

# Build for production
npm run build

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  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 file for details.