This project serves as the backbone for a video hosting website, showcasing features such as user authentication, video management, commenting, subscription management, and more. Please note that this repository contains only the backend implementation.
This project not only provides essential features for a video hosting website but also serves as a learning resource for various aspects of backend development. By exploring this project, you will gain insights into:
- User Authentication: Utilizing JWT for secure user authentication.
- Video Management: Allowing users to upload, like, dislike, and comment on videos.
- Subscription System: Enabling users to subscribe and unsubscribe from channels.
- Secure Practices: Implementing JWT, Bcrypt, Access Tokens, Refresh Tokens, and more.
These features are designed to help you grasp concepts crucial for building a complex backend system. The project covers secure authentication practices, multimedia data management in a MongoDB database, and the incorporation of various features essential for a video hosting platform.
Before you begin, ensure you have met the following requirements:
- Node.js installed
- MongoDB database set up
- Cloudinary account for cloud storage
-
Clone the repository:
git clone https://github.com/lokeshwar777/loki-backend.git cd loki-backend -
Install dependencies:
npm install
-
Set up your environment variables.
-
Run the application:
npm run dev
-
Access the server at http://localhost:8000
/src
├── db
│ └── index.js
├── models
│ ├── comment.model.js
│ ├── subscription.model.js
│ ├── like.model.js
│ ├── playlist.model.js
│ ├── tweet.model.js
│ ├── user.model.js
│ └── video.model.js
├── routes
│ └── userRoutes.js
├── controllers
│ └── userController.js
├── middlewares
│ ├── authMiddleware.js
│ └── multerMiddleware.js
├── utils
│ ├── ApiError.js
│ ├── ApiResponse.js
│ ├── asyncHandler.js
│ └── cloudinary.js
├── app.js
├── constants.js
└── index.js
This project is open for contributions, and your input is highly valued. If you encounter any issues or have ideas for improvements, please feel free to contribute. Follow the steps below to get started:
-
Fork the repository to your GitHub account.
-
Clone the forked repository to your local machine:
git clone https://github.com/your-username/loki-backend.git
cd loki-backend
- Create a new branch for your contribution:
git checkout -b feature/your-feature
- Make your changes and commit them:
git add .
git commit -m "Add your concise commit message"
- Push your changes to your forked repository:
git push origin feature/your-feature
- Create a pull request from your branch to the main repository.
If you come across any issues or have suggestions, please create an issue.
- Node.js - A JavaScript runtime built on Chrome's V8 JavaScript engine.
- Express - Web framework for Node.js.
- MongoDB - NoSQL database for storing application data.
- Mongoose - MongoDB object modeling for Node.js.
- JWT - JSON Web Token for secure authentication.
- Multer - Middleware for handling file uploads.
- Nodemon - Utility that monitors for changes and automatically restarts the server.
- Cloudinary - Cloud-based image and video management service.
During the development and testing of controllers, you can use tools like Postman or Thunderclient to send HTTP requests and interact with the API endpoints. These tools provide a user-friendly interface to test various functionalities, inspect responses, and ensure the smooth operation of your backend.
Feel free to leverage these tools to streamline the testing process and ensure the robustness of your backend controllers.
Projects inspired by the "Chai aur Javascript Backend" Playlist from Hitesh Choudhary.
This project benefited from the assistance of ChatGPT, a language model developed by OpenAI. ChatGPT provided guidance and help in refining certain aspects of the project.
This project is licensed under the MIT License.