InstaPuppeteer

A web-based automation tool for streamlined Instagram management
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

InstaPuppeteer is a web-based automation tool that leverages browser automation to streamline Instagram management tasks. The application provides users with the ability to automate routine Instagram activities through an intuitive web interface and dashboard.

The project aims to create a user-friendly platform where users can configure and schedule various Instagram automation workflows. By utilizing headless browser technology with Puppeteer, the application can interact with Instagram's web interface programmatically while maintaining natural browsing patterns.

Here's why InstaPuppeteer stands out:

• User-Friendly Dashboard: Intuitive web interface for managing automation tasks
• Browser Automation: Uses Puppeteer for reliable, programmatic Instagram interactions
• Natural Patterns: Maintains human-like browsing behavior to ensure account safety
• Configurable Workflows: Flexible automation settings tailored to your needs

Current features include automated liking of posts from specified hashtags, with more automation capabilities planned for future releases.

(back to top)

Built With

This project is built using modern web technologies to ensure performance, reliability, and maintainability.

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get InstaPuppeteer up and running locally, follow these simple steps.

Prerequisites

Before you begin, ensure you have the following installed on your system:

• Yarn package manager

  npm install -g yarn

Installation

1. Clone the repository

   git clone https://github.com/StereoPT/insta-puppeteer.git

2. Navigate to the project directory

   cd insta-puppeteer

3. Install dependencies

   yarn install

4. Set up environment variables

   cp .env.example .env

   Edit the .env file and add your required environment variables as specified in the example file.

5. Set up the database

   yarn db:migrate:dev

6. Start the development server

   yarn dev:dashboard

The application will be available at http://localhost:3000.

(back to top)

Usage

InstaPuppeteer provides an intuitive web dashboard for managing your Instagram automation tasks.

Current Features

Hashtag Automation: Automatically like posts from specified hashtags

• Configure target hashtags through the web interface
• Monitor automation activity in real-time

Getting Started with Automation

1. Login: Access the web dashboard at http://localhost:3000/login
2. Create Workflow: Define hashtag
3. Monitor: Track automation progress and results

⚠️ Important: Always ensure your automation activities comply with Instagram's Terms of Service and community guidelines.

(back to top)

Roadmap

• Hashtag-based post liking automation
• Web-based dashboard interface
• SQLite database integration
• Fix known issues
• Improved Dashboard
• Hashtag Management

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Development Guidelines

• Follow the existing code style and conventions
• Write clear, descriptive commit messages
• Test your changes thoroughly before submitting
• Update documentation as needed
• Respect Instagram's Terms of Service in all contributions

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

StereoPT - @StereoPT - Open an issue

Project Link: https://github.com/StereoPT/insta-puppeteer

(back to top)

Acknowledgments

Special thanks to the following resources and libraries that made this project possible:

• Puppeteer Documentation
• Shadcn/ui Components

(back to top)