Skip to content

Advaitgaur004/Youtube-Clone

Repository files navigation

YouTube Clone

Table of Contents

Introduction

Welcome to the YouTube Clone project! This project aims to replicate the core features of YouTube, providing a platform where users can upload, view, and interact with videos. This README will guide you through the setup and usage of the project.

Features

  • User authentication (signup, login, logout)
  • Video upload and playback
  • Video search functionality
  • User profiles
  • Like and comment on videos
  • Subscription to channels
  • Video recommendations

Technologies Used

  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Authentication: JWT (JSON Web Tokens)
  • Storage: AWS S3 (or alternative storage solution)

Installation

Prerequisites

Ensure you have the following installed on your machine:

  • Node.js (>= 14.x)
  • npm (>= 6.x) or yarn (>= 1.x)
  • MongoDB (>= 4.x)
  • AWS account (for S3 storage, if applicable)

Steps

  1. Clone the repository:

    git clone https://github.com/Advaitgaur004/Youtube-Clone.git
    cd Youtube-Clone
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Set up environment variables: Create a .env file in the root of the project and add the following:

    MONGODB_URI=your_mongodb_uri
    JWT_SECRET=your_jwt_secret
    AWS_ACCESS_KEY_ID=your_aws_access_key
    AWS_SECRET_ACCESS_KEY=your_aws_secret_key
    S3_BUCKET_NAME=your_s3_bucket_name
    
  4. Run the application:

    npm start dev
    # or
    yarn start
  5. Open your browser and navigate to:

    http://localhost:8000
    

Usage

  • Sign up: Create a new account by providing a username, email, and password.
  • Login: Access your account using your credentials.
  • Upload Video: Upload videos by navigating to the upload section.
  • View Videos: Browse and view videos uploaded by other users.
  • Interact: Like, comment, and subscribe to channels of interest.

Contributing

We welcome contributions to enhance the YouTube Clone project. To contribute, please follow these steps:

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

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or feedback, please contact:


Thank you for checking out the YouTube Clone project!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published