Skip to content

aindong/social-media-scraper

Repository files navigation

Social Media Scraper

This project is for research purposes, not intended to steal content or data from any social media platform. It can only be used to scrape public data from social media platforms. The project is still under development, so it is not recommended to use it in production.

Usage

import SocialMediaScraper from '@aindong/social-media-scraper';

async function main() {
    const data = await SocialMediaScraper.scrape(['https://www.instagram.com/mrnigelng/', 'https://www.tiktok.com/@mrnigelng']);
    console.log(data);
}

Contribution Guidelines

Welcome to the project! We appreciate your interest in contributing. By participating in this project, you agree to abide by the Code of Conduct.

Getting Started

  • Make sure you have a GitHub account.
  • Fork the repository on GitHub.
  • Clone the forked repository to your local machine.
  • Create a new branch for your changes.

Making Contributions

Submitting Changes

  1. Ensure that your code adheres to the project's coding conventions and style guidelines.
  2. Provide clear and descriptive commit messages.
  3. Make sure your changes are focused and address a specific issue or feature.
  4. Test your changes thoroughly to ensure they function as expected.
  5. Update any relevant documentation, including code comments, README, or other project-specific documentation.
  6. Push your changes to your forked repository.
  7. Submit a pull request to the main repository, clearly describing the changes introduced.

Code Reviews

  • All pull requests will undergo code reviews by project maintainers.
  • Be responsive to feedback and be open to making necessary changes based on the review.
  • Respond to comments and questions promptly.
  • Once the changes have been reviewed and approved, they will be merged into the main repository.

Issue Reporting

  • Before creating a new issue, search the existing issues to ensure it hasn't been reported before.
  • Use a descriptive title and provide a clear description of the issue, including steps to reproduce if applicable.
  • Include relevant details such as the operating system, browser, or any other relevant environment information.

Code of Conduct

Please review and adhere to the Code of Conduct to ensure a positive and inclusive community experience.

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE file.

Thank you for considering contributing to the project! Your contributions are greatly appreciated. Happy coding!