Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adrien2p/instauto2

Instauto2 is providing typescript support, language and db adapters
https://github.com/adrien2p/instauto2

automation bot bot-library follow instagram instagram-auto-follow instagram-automation unfollow

Last synced: about 2 months ago
JSON representation

Instauto2 is providing typescript support, language and db adapters

Awesome Lists containing this project

README

        

[![Npm package version](https://badgen.net/npm/v/instauto2)](https://npmjs.com/package/instauto2)
[![Npm package daily downloads](https://badgen.net/npm/dd/instauto2)](https://npmjs.com/package/instauto2)
[![Npm package monthly downloads](https://badgen.net/npm/dm/instauto2)](https://npmjs.com/package/instauto2)
[![Npm package monthly downloads](https://badgen.net/npm/dy/instauto2)](https://npmjs.com/package/instauto2)
[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/adrien2p/instauto2/blob/main/LICENCE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)



instauto2 is an Instagram automation/bot library written in modern, clean javascript using Google's Puppeteer-core. Goal is to be very easy to set up, use, and extend, and obey instagram's limits. Heavily inspired by [InstaPy](https://github.com/timgrossmann/InstaPy).

Also, this library is a huge upgrade from [instauto](https://github.com/mifi/instauto)

## Setup

- First install [Node.js](https://nodejs.org/en/).

- Create a new directory with a file like [example.js](https://github.com/adrien2p/instauto2/blob/main/example.js)
or [example-loki.js](https://github.com/adrien2p/instauto2/blob/main/example-loki.js)

- Adjust your `example.js` to your needs. If you want to see how it would work without doing any invasive actions, use the `dryRun: true` option. Toggle `headless` to see it in action.

- Open a terminal in the directory

- Run `npm i`

- Run `npm i puppeteer-core instauto2`

- Run `node example`

You can run this code for example once every day using cron or pm2 or similar

## Supported functionality

- Follow the followers of some particular users. (e.g. celebrities.) Parameters like max/min ratio for followers/following can be set.

- Unfollow users that don't follow us back. Will not unfollow any users that we recently followed.

- Unfollow auto followed users (also those following us back) after a certain number of days.

- The code automatically prevents breaching 100 follow/unfollows per hour or 700 per 24hr, to prevent bans. This can be configured.

See [example.js](https://github.com/adrien2p/instauto2/blob/main/example.js) or [example-loki.js](https://github.com/adrien2p/instauto2/blob/main/example-loki.js) for example of features

## Data management

The data are stored in json files by default using the `file-db.adapter` internally.
If you need to override the default behavior you can either choose to use the other adapter provided which is using
[lokijs](https://github.com/techfort/LokiJS) or you could create your own adapter to pass to `instauto`.

### Creating your own adapter

To create your own adapter you can have a look to [loki-db.adapter.ts](https://github.com/adrien2p/instauto2/blob/main/src/core/db_adapters/loki-db.adapter.ts).
Basically you need to create a class that extend the [AbstractDbAdapter](https://github.com/adrien2p/instauto2/blob/main/src/core/db_adapters/abstract-db.adapter.ts)
such as :

```typescript
export class MyAdapter extends AbstractDbAdapter {
constructor(private readonly instance: YourInstanceType, private readonly logger: LiteLogger) {
super();
}

addLikedPhoto({ username, href, time }: LikedPhoto): Promise {
// ... You code goes here ...
}

addPrevFollowedUser(follower: Follower): Promise {
// ... You code goes here ...
}

addPrevUnfollowedUser(unfollower: UnFollower): Promise {
// ... You code goes here ...
}

getFollowedLastTimeUnit(timeUnit: number): Promise {
// ... You code goes here ...
}

getLikedPhotosLastTimeUnit(timeUnit: number): Promise {
// ... You code goes here ...
}

getPrevFollowedUser(username: string): Promise {
// ... You code goes here ...
}

getUnfollowedLastTimeUnit(timeUnit: number): Promise {
// ... You code goes here ...
}
}
```

To see how to use you own adapter you can have a look to the [example-loki.js](https://github.com/adrien2p/instauto2/blob/main/example-loki.js)

## Language

The library support multiple language for logging purpose.
The default language is `english` but you can switch to `french` or provide your own language.

to change to language using the provided translation see the following example

```typescript
languageManager.useExistingCustomLanguage('fr');

// or

languageManager.useExistingCustomLanguage('en');
```

to be able to provide your own translations use the following example

```typescript
languageManager.setCustomLanguage({
// The translations goes here
});
```
Finally, to reset the language to the original one (en), use the following example

```typescript
languageManager.resetLanguage();
```

## Tips

- Run this on a machine with a non-cloud IP to avoid being banned

## Troubleshooting

- If it doesn't work, make sure your instagram language is set to english

See also:
- https://github.com/GoogleChrome/puppeteer/issues/550
- https://github.com/GoogleChrome/puppeteer/issues/3774

Also you might want to install the more lightweight package `puppeteer-core` instead of `puppeteer`.

Made with ❤️ in 🇫🇷