rodgracas / cliptale

Automate your Instagram stories clipping using Puppeteer 📎

Cliptale 📎

• Combination of clipping (method to clip off something) + tales (stories - Instagram)

Automate your Instagram stories clipping using Puppeteer.

What is clipping in Marketing?

Since Instagram stories have a period of 24 hours, clipping allows you to record this content to later be shared with the customer. It can also be considered as a consumer analysis tool, often referred to as target.

The problem cliptale solves

As a Campaign Manager, with several campaigns in hand with different IG profiles, it takes a lot of time to run each account and perform the clipping.

The solution

cliptale automates the clipping of Instagram stories, making this process faster, easier and more efficient. Just provide a list of IG profiles, and cliptale will return the current available stories content in .jpeg format, and saved them into a dedicated folder.

Table of contents

• Cliptale 📎
  • What is clipping in Marketing?
  • The problem cliptale solves
  • The solution
  • Table of contents
  • Set up
    • Instagram credentials
    • Instagram profile users
  • Install
  • Run
  • Next steps
  • VS Code
  • Contributing
    • Pull Request Process

Set up

Open your terminal and run the following commands:

# Get repository
git clone [e-mail]:rodgracas/cliptale.git

# Enter project directory
cd cliptale

Instagram credentials

# Create a .env file in project root.
cp .env.sample .env

• Edit IG_USERNAME and IG_PASSWORD environment variables with the Instagram account used to authenticate.

Note: The Instagram account used should not have 2FA enabled.

Instagram profile users

• Edit users.json file in data/ folder

Note: Users profiles must be available from the Instagram account used to login.

Install

# Install dependencies
npm install

Run

npm start

Note: By default cliptale runs in headless mode. To run in headfull mode, set DEBUG variable to true on clipping.js file.

Next steps

• Run in headless mode
• Add Prettier
• Add Eslint
• Create API
• Write tests
• Typescript support
• Create web application

VS Code

cliptale has a .vscode folder setup with some default settings and recommended extensions for VS Code editor.

To start using these settings, open your terminal and run:

# In root
cp .vscode/settings.json.default .vscode/settings.json

You can change your settings.json as you wish since they will not be tracked on Git. If you want to add some changes to the default settings, please feel free to add on the settings.json.default file.

Contributing

Contributions are welcome 😀 This is my first open-source project on Github, so I would be very grateful to share your thoughts on this project, solve any issues and receive your feedback for improvements or enhancements.

When contributing to this repository, please first discuss the change you wish to make by opening an issue.

Pull Request Process

1. Fork the repo on GitHub
2. Clone the forked repo to your machine
3. Commit changes to your own branch
4. Push your work onto your forked repository
5. Submit a Pull request so that I can review your changes