This project contains backend API-endpoints for a complex and fully-functional video sharing platform, built using Node/Express for writing backend code and MongoDB/Mongoose for database utilities. This project also leverages the power of third-party services such as Cloudinary for image and file uploads.
The code for this project is written keeping in mind the best-practices related to JavaScript and backend development in general.
Moreover, complex and production-grade concepts such as MongoDB Aggregation Pipelines have been incorporated at all places in the code wherever required.
This backend code can facilitate beginner to intermediate developers to create an independent, fully-functional and production-grade web application similar to the like of Youtube and other video sharing platforms.
This backend provides almost all the features that a complex and fully functioning video sharing platform consists. Below mentioned are a few of the many features of this project.
- Secure and error-proof code using modern JS code principles like async-await and try-catch
- Modular and structured code obeying the industry best-practices
- Heavily commented code explaining each line of code
- MongoDB Aggregation Pipelines for complex database queries
- Secured Authentication (using JWTs)
- Authentication via browser cookies
- Mongoose custom methods and middlewares
- Password Hashing (using Bcrypt)
- Seamless Image and File uploads (using Cloudinary and Multer)
- Ensure that you have Node installed in your machine locally (if not, install from here) by running the following command
node- Clone the repository by running the following command
git clone https://github.com/Abhijeet-Gautam5702/video_sharing_platform_backend.git- Install the dependencies
npm install-
Create your own MongoDB instance from the official website.
-
Taking the
.env.examplefile as reference, create a new.envfile in the root directory and populate it with required sensitive information like API-Keys, JWT-secrets etc. -
Use Postman (recommended) or any other API-testing tool to test the endpoints.
The POSTMAN API-Collection is provided in the root-directory for testing all the below mentioned API-endpoints.
SERVER : http://localhost:<PORT>/api/v1
This project contains one of the most comprehensive code and API-endpoints for user related backend endpoints.
GET : <SERVER>/users/get-current-user
GET : <SERVER>/users/user-watch-history
POST : <SERVER>/users/register
BODY (form-data)
username:
fullname:
email:
password:
avatar:
cover:POST : <SERVER>/users/login
BODY (form-data)
username:
email:
password:POST : <SERVER>/users/logout
PUT : <SERVER>/users/refresh-access-token
PUT : <SERVER>/users/change-password
BODY (raw JSON)
{
oldPassword: ,
newPassword: ,
confirmPassword:
}PUT : <SERVER>/users/update-account-details
BODY (raw JSON)
{
fullname: ,
email:
}PUT : <SERVER>/users/update-account-images
BODY (form-data)
avatar:
cover:GET : <SERVER>/videos/get-videos
GET : <SERVER>/videos/get-video-by-id/:videoId
POST : <SERVER>/videos/publish-video
BODY (form-data)
title:
description:
thumbnail:
videoFile:DELETE : <SERVER>/videos/delete-video/:videoId
PATCH : <SERVER>/videos/update-video-details/:videoId
BODY (form-data)
title:
description:PATCH : <SERVER>/videos/toggle-video-publish-status/:videoId
PATCH : <SERVER>/videos/update-video-thumbnail/:videoId
BODY (form-data)
thumbnail:GET : <SERVER>/comments/comments/:videoId
POST : <SERVER>/comments/add-comment/:videoId
BODY (raw JSON)
{
content: "comment content here"
}DELETE : <SERVER>/comments/delete-comment/:commentId
PUT : <SERVER>/comments/edit-comment/:commentId
BODY (raw JSON)
{
content: "updated comment content here"
}GET : <SERVER>/likes/get-liked-videos
POST : <SERVER>/likes/toggle-video-like/:videoId
POST : <SERVER>/likes/toggle-comment-like/:videoId
GET : <SERVER>/channels/get-channel-details/:channelUsername
GET : <SERVER>/dashboard/get-channel-videos
GET : <SERVER>/dashboard/get-channel-stats
GET : <SERVER>/playlists/get-playlists
GET : <SERVER>/playlists/get-videos-in-playlist/:playlistId
GET : <SERVER>/playlists/get-playlist-by-id/:playlistId
POST : <SERVER>/playlists/create-playlist
BODY (form-data)
title:
description:POST : <SERVER>/playlists/add-video-to-playlist/:playlistId
BODY (form-data)
videoId:DELETE : <SERVER>/playlists/delete-playlist/:playlistId
PUT : <SERVER>/playlists/remove-video-from-playlist/:playlistId
BODY (form-data)
videoId:PUT : <SERVER>/playlists/update-playlist/:playlistId
BODY (form-data)
title:
description: