abhi1o / get-youtube-subscribers

RESTful API to get YouTube subscribers information.

GET YOUTUBE SUBSCRIBERS

Node.js application to get all details of youtube subscribers.

DEMO

Table of Contents

• Introduction
• Features
• Tech Stack
• Prerequisites
• Installation & Run
• API Reference
• Contribute
• Contributors
• License
• Contact
• Acknowledgments

Introduction

Get YouTube Subscribers is an Application that serves as a RESTful API created by using Mongodb in Node.js. It is designed to fetch all subscribers information related to YouTube channel subscribers. The primary technologies used to develop this application are Node.js and Express.js which are used to create API endpoint and manage HTTP request. Additionally, this application utilizes MongoDB as the database to store and manage subscribers data efficiently.

Features

Some features of this application :

• Seamless Data Retrieval: Effortlessly fetch subscribers data from YouTube channels using API endpoints.
• Structured JSON Output: Present retrieved data in well-organized JSON format for easy interpretation.
• Versatile API Endpoints: Provide users with multiple API endpoints catering to various data retrieval needs.
• Effective YouTube Data API Integration: Interact seamlessly with the YouTube Data API for accurate data retrieval.
• User-Friendly Setup: Follow a straightforward setup process, enabling swift utilization of the tool.

Tech Stack

GET-Youtube-Subscriber is build using the following technologies:

• Node.js: A runtime environment that execute javaScript code on the server-side.
• Express.js: A node.js framework for building web application and RESTful API.
• MongoDB: Is NoSQL Database system that stores and manage data in JSON-like format.

Prerequisites

To run this project locally, make sure you have the following installed:

• Node.js
• MongoDB

Installation and Run

1. Clone the repository from GitHub:

    git clone https://github.com/Abhi1o/GET-YOUTUBE-SUBSCRIBERS
   

2. Redirect to the project folder:

    cd GET-YOUTUBE-SUBSCRIBERS
   

3. Install the required dependencies:

    npm install
   

4. Configure the application:
   • Create a .env file in the root directory of the project.
   • Add the following environment variables to the .env file:

      PORT=3000                             # The port on which the application will run
      DATABASE_URI= <your_uri_here>         # The MongoDB connection string
     

5. Create Database:
   • Inserting subscribers data into MongoDB.

      npm run createDB
     

6. Start server:

    npm start
   

   [!NOTE] Access the application in your web browser at http://localhost:3000 (base URL)

API Reference

Following API endpoints for retrieving subscribers information using the GET method. For more refer to the API-Documentation.

• /subscribers: Retrieve a list of all subscribers with their ID, name, subscribed channel and date.
• /subscribers/names: Obtain subscribers name along with the channel they are subscribed to.
• /subscribers/id: Access subscriber information based on their ID.

Contribute

Contributions are welcome! If you'd like to contribute, please follow our Contribution Guidelines.

Contributors

• Abhishek Kumar GitHub | LinkedIn | YouTube
• Aman Giri GitHub | LinkedIn | YouTube
• Damini Gadpal GitHub | LinkedIn | YouTube

License

This project is Distributed under the ISC License. See LICENSE for more information.

Contact

If you have any questions or suggestions, feel free to reach out to us at Gmail.

Acknowledgment

We'd like to thank the open-source community and the creators of Node.js, Express, and MongoDB for their valuable contributions.

We would also like to thank the contributors to this project for their valuable contributions.

Happy Learning