This is learning project for backend development.

Table of Contents

• Description
• Prerequisites
• Installation
• Usage
• Contributing
• Tests
• License
• Notes
• Questions

Description

This project is a robust backend built with ExpressJS and MongoDB, designed to handle a variety of operations for a social media-like platform. It includes user controllers that manage registration, login, logout, and other user-related functionalities. The video controller allows users to perform CRUD operations on videos. Similarly, users can create, read, update, and delete comments and tweets. The like controller enables users to like videos, comments, and tweets, enhancing user interaction and engagement. Additionally, a dashboard controller provides an overview of user activities and interactions. This backend serves as a solid foundation for a future frontend, paving the way for a full-stack social media application.

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed the latest version of Node.js and npm.
• You have a Windows/Linux/Mac machine.
• You have read guide to Express.js.
• You have a basic understanding of JavaScript and MongoDB.
• You have MongoDB installed or have a MongoDB Atlas account.

Installation

Follow these steps to get the project set up on your local machine:

1. Clone the repository: First, you will need to clone the repository to your local machine. You can do this with the following command:

   git clone https://github.com/namankoolwal/VideoTube-Backend.git

2. Navigate to the project directory: Change your current directory to the project's directory:

   cd VideoTube-Backend

3. Install the dependencies: Now, you can install the necessary dependencies for the project:

   npm install -g nodemon
   npm install
   

4. Set up environment variables: Copy the .env.example file and rename it to .env. Then, fill in the necessary environment variables.

5. Start the server: Finally, you can start the server:

   npm run dev

Now, you should be able to access the application at http://localhost:8000 (or whatever port you specified).

Usage

This project is a backend application, so you'll interact with it using API endpoints. Here are some examples:

User Registration

To register a new user, send a POST request to /api/v1/users/register with the following data:

{
  "username": "example",
  "email": "example@email.com",
  "password": "examplepassword",
  "fullName": "Example User",
  "avatar": "avatar.jpg",
  "coverImage": "coverImage.jpg",
}

User Login

To login, send a POST request to /api/v1/users/login with the following data:

{
  "email": "example@email",
  "password": "examplepassword"
}

User Logout

To logout, send a POST request to /api/v1/users/logout .

There a lot of endpoint you can see in routes.

Contributing

This project is open source and it is based on learning, this project is from "Chai-aur-code" yt channel.

Tests

This project uses Postman for testing its API endpoints. here is a postman collection import in your postman collection and set the environment variables. variable : 'server' initialValue : http://localhost:8000/api/v1/ currentValue : http://localhost:8000/api/v1/

import this file in postman collection.: https://drive.google.com/file/d/1RXqlxN6Z2BaJRR_qr16EKXV0IJSdVVHc/view?usp=sharing

The tests cover the following areas:

• User registration, login, and logout
• Video CRUD operations
• Comment CRUD operations
• Tweet CRUD operations
• Playlist CRUD operations
• Subscription Functionality
• Liking videos, comments, and tweets
• HealthCheck Functionality
• Dashboard Functionality

Please note that you'll need to update the environment variables in Postman to match your local setup (e.g., base_url, user_token).

Notes

All controllers notes for easier understanding : VideoTube-Backend-Notes.pdf

License

This project is licensed under the Chai-aur-code license.

Questions

If you have any questions or feedback, please feel free to reach out to me via GitHub.