Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tejaswinit167/ytcommentsnavigator
YTCommentsNavigator is a web app for fetching, displaying, and getting customized YouTube comments. It allows users to search and filter comments by likes and sentiment (positive or negative). Made for fellow kindred spirits who spend more time in the comment section than the actual video! 😄
https://github.com/tejaswinit167/ytcommentsnavigator
dockerfile expressjs full-stack-web-development mongodb-atlas nodejs python3 reactjs youtube-api
Last synced: about 1 month ago
JSON representation
YTCommentsNavigator is a web app for fetching, displaying, and getting customized YouTube comments. It allows users to search and filter comments by likes and sentiment (positive or negative). Made for fellow kindred spirits who spend more time in the comment section than the actual video! 😄
- Host: GitHub
- URL: https://github.com/tejaswinit167/ytcommentsnavigator
- Owner: TejaswiniT167
- License: mit
- Created: 2024-08-01T17:09:10.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-13T04:21:12.000Z (about 1 month ago)
- Last Synced: 2024-12-13T05:19:41.130Z (about 1 month ago)
- Topics: dockerfile, expressjs, full-stack-web-development, mongodb-atlas, nodejs, python3, reactjs, youtube-api
- Language: JavaScript
- Homepage:
- Size: 7.57 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YouTube-Comments-Navigator
YTCommentsNavigator is a web application that enables users to perform customized navigation of YouTube comments. Built with the MERN stack, Python, and the YouTube Data API, this tool allows users to search within the comments, filter comments by likes, and analyze sentiment/general reaction i.e, positive or negative. It provides enhanced comment navigation tailored to user needs :)
## Features and Benefits
### Enhanced Comment Navigation
- **Comprehensive Comment Browsing**: Search and filter through YouTube comments with ease, helping users to quickly find relevant comments without endless scrolling.
- **Streamlined Search and Filter**: Efficiently find comments based on keywords and likes, allowing for better navigation through large volumes of comments.
### Sentiment Analysis
- **Positive and Negative Filtering**: Analyze and filter comments by sentiment (positive or negative) using a simple rule-based model with TextBlob. Users can replace this with their own preferred approaches or self trained NLP models in `sentiment_analysis.py` for better specific results.
- **Instant Feedback**: Influencers and businesses can quickly gather feedback and insights, helping them to understand audience sentiment and make informed decisions.
### User-Centric Features
- **Customized Search**: Tailor searches to find the most liked comments swiftly, providing a more focused and efficient browsing experience.
- **Robust Comment Management**: Enhance user interaction by providing a platform to navigate through comments based on specific needs and preferences.
- **Research and Analysis**: Useful for researchers and hobbyists analyzing public sentiment and engagement on various topics, if made a legit option on the platform.
- **Educational Use**: Beneficial for learners in general, seeking doubt clarification and topic discussions within the comment section, providing for an optimized learning experience.
## Technologies Used
- **Frontend**: React.js, HTML, CSS
- **Backend**: Node.js, Express.js
- **Database**: MongoDB(Atlas)
- **Scripting**: Python
- **APIs**: YouTube Data API
## Getting Started
### Prerequisites
Ensure you have the following installed on your system:
- Node.js
- npm or yarn
- Python
Ensure you get your credentials for the below mentioned, required for this webapp working:
- MongoDB Atlas Connection string,
In case you are using mongodb locally installed on your system, you can make slight code adjustments accordingly for database connection.
- YouTube API Key
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/TejaswiniT167/YTCommentsNavigator.git
cd YTCommentsNavigator
```
2. **Setup Environment Variables:**
Create a `.env` file at the root of the project by copying the example:
```bash
cp .env.example .env
```
Fill in your MongoDB URI and YouTube API key in the `.env` file.
```plaintext
# .env
MONGO_URI=your_mongo_uri
API_KEY=your_youtube_api_key
```
3. **Install Dependencies:**
Excecute the below commands in respective directories:
- **Frontend:**
```bash
cd frontend
npm install
npm run build
```
- **Backend:**
```bash
cd backend
npm install
```
- **Python:**
```bash
cd python
python -m venv com
source com/bin/activate # On Windows use `com\Scripts\activate`
pip install -r requirements.txt
```
### Running the Application
1. **Start the Backend (which serves the React app):**
```bash
cd backend
npm start
```
## Accessing the Web App
After successfully building the React app and starting the backend server, the web app can be accessed at `http://localhost:5000`. The backend server serves the React app we built using `npm run build` and utilizes Python scripts as child processes to fetch and process YouTube comments with YouTube API.
The backend directs to various routes to achieve different functionalities:
- **Fetching Comments**: `/api/fetch_comments` route is used to fetch comments from a specified YouTube video and store them in MongoDB.
- **Searching Comments**: `/api/search` route allows users to search from the comments stored in MongoDb by above action, based on keywords.
- **Sorting/Filtering by Likes**: `/api/byLikes` route sorts the comments by the number of likes, when the 'Filte by' likes option is selected.
- **Filtering by Sentiment**: `/api/bySentiment` route filters comments based on sentiment (positive or negative) providing relavent comments based on the selected 'Filter by' option on the website i.e positive/negative.
These routes work together for providing users with customized search capabilities and insights.
## Dockerization
Dockerization allows you to run the entire application with minimal setup. Instead of following the above commands, you can use Docker to containerize the application and ensure it runs consistently across different environments, allowing for simplifying deployment and managing dependencies.
**Prerequisites :** Docker Desktop
### Steps to dockerize
1. **Clone the repository and set up environment variables:**
Follow the first two steps from the [Getting Started](#getting-started) section to clone the repository and set up your `.env` file with the necessary your credentials.
2. **Build your Docker container and run the app:**
```bash
docker build -t ytcommentsnavigator .
docker run -p 5000:5000 --env-file .env ytcommentsnavigator
```
This command will build the Docker image for the application and then start the container.
This will build the Docker images for the frontend, backend, and Python scripts, and then start the containers.
Once the containers are up and running, the web app can be accessed at `http://localhost:5000`.
#### Note: if you are running the application locally without Docker, you can safely delete the Docker-related `Dockerfile` from the repository.
In this project, docker-compose.yml might not be necessary since a single container handles the frontend, backend, and Python child process calls. However, if each service becomes more complex or you add additional features or separate services like a local database, Docker Compose will be beneficial for managing and orchestrating multiple containers efficiently.
## Contributing
I started this project because I often found myself endlessly scrolling through YouTube comments, looking for the most liked ones and discussions about topics of my concern. I believe with functionalities like these, it provides for a better user experience, saving time and enabling efficient navigation.
If you feel the same way and have ideas for new features or improvements to existing ones, you can start with this project and build additional features upon it to enhance its functionality further. Your contributions are always welcome, and a mention of my initial work is highly appreciated :)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.