Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davodm/irancrypto-social-bot
IranCrypto.market social bot which send daily/weekly stats and trends to different platforms
https://github.com/davodm/irancrypto-social-bot
Last synced: 11 days ago
JSON representation
IranCrypto.market social bot which send daily/weekly stats and trends to different platforms
- Host: GitHub
- URL: https://github.com/davodm/irancrypto-social-bot
- Owner: davodm
- License: mit
- Created: 2023-08-19T13:33:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-30T16:04:21.000Z (4 months ago)
- Last Synced: 2024-07-30T20:14:41.478Z (4 months ago)
- Language: JavaScript
- Homepage: https://irancrypto.market/
- Size: 505 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IranCrypto Market Social Media Bot
The IranCrypto Market Social Media Bot is a powerful project that leverages Node.js and AWS Lambda to automate the generation of daily/weekly crypto market updates on social media platforms, including Twitter, Telegram and Instagram. It utilizes the IranCrypto API to fetch data on the most popular cryptocurrencies and then generates insightful content, complete with engaging English-language tweets and Instagram posts.
### Features
* **Crypto Market Data:** Fetches daily and weekly rankings of top cryptocurrencies from the IranCryptoMarket API.
* **Engaging Content Generation:** Uses ChatGPT to create compelling English-language tweets that discuss the performance, volume, and price changes of the top cryptocurrencies.
* **Instagram Image Creation:** Generates images for Instagram posts using [Node HTML to image](https://www.npmjs.com/package/node-html-to-image), based on templates created for the project.
* **Twitter Integration:** Posts generated content on Twitter using the [Twitter API V2](https://www.npmjs.com/package/twitter-api-v2), with credentials obtained using a CLI tool.
* **Instagram Posting:** Shares the generated images as both posts and stories on Instagram, utilizing the [Instagram private API](https://www.npmjs.com/package/instagram-private-api).
* **Telegram Posting:** Shares the generated images on Telegram channel, utilizing the [Node.JS Telegram Bot API](https://www.npmjs.com/package/node-telegram-bot-api).
* **Serverless Execution:** Runs daily via AWS Lambda on a cron schedule, ensuring maintenance-free execution and scalability.
## Setup & Usage
Twitter access token it's not a straight forward way, But for the rest of the modules, you just need to use the credientials on .env file.
1. **Developer Portal Setup:** Begin by setting up your developer portal on Twitter.
2. **Application Creation:** Create a new application within your developer portal.
3. **User Authentication Setup:** Set up user authentication for your project, including specifying a callback URL. (Callback URL could be anything, we just need to copy it after redirection)
4. **Environment Variables:** Configure your environment variables by adding them to the .env file. These variables include API keys, access tokens, and credentials for Twitter and Instagram.
```sh
OPENAI_MODEL=gpt-3.5-turbo
OPENAI_API_KEY=
OPENAI_ORGANIZATION=
DYNAMODB_TABLE=
IRANCRYPTO_API_KEY=
TWITTER_ACCESS_TOKEN=
TWITTER_REFRESH_TOKEN=
TWITTER_CLIENT_ID=
TWITTER_CLIENT_SECRET=
TWITTER_CALLBACK_URL=https://randomurl/twitterbot/ //Should be the same with your Twitter app config
IG_USERNAME=
IG_PASSWORD=
IG_PROXY=
IG_PRELOGIN=false //If you want to use prelogin simulation, set it to true
IG_STORE_SESSION=true //If you want to store session on DynamoDB, set it to true
TELEGRAM_CHANNEL_ID=
TELEGRAM_BOT_TOKEN=
```
5. **Twitter Authentication:** Use the provided CLI tool to authenticate and configure Twitter credentials. This tool will guide you through the authentication process and generate access and refresh tokens.
```sh
$ npm run twitter-auth
> Save Code verifierer below ->
<....>
Go to this link to auth your account ->
After all answer the prompts!
```
6. **Token Storage:** The project uses DynamoDB to store and manage your Twitter tokens, ensuring that they are refreshed as needed.
Read more [technical details](https://github.com/PLhery/node-twitter-api-v2/blob/712ca82293c1b587638055537969dbec5a7bce40/doc/auth.md#user-wide-authentication-flow) on the Twitter authentication flow used.
7. **Instagram Checkpoint Bypass:** In case of Instagram blockage, you can use the CLI tool to bypass the checkpoint.
```sh
$ npm run instagram-auth
```
1. **Telegram Channel ID:** You can use [JSONDump Bot](https://t.me/JsonDumpBot) by forwarding a post from your channel to the bot to identify the channel id.
```sh
## Installation
1. Clone Repo
2. Run `npm install`
3. Create .env file and fill out the values as explained
4. Deploy lambda function through [serverless](https://www.serverless.com/framework/docs/providers/aws/guide/deploying): `npm run deploy`
Whole serverless configuration will create DynamoDB table, attach the needed permissions and set the cronjob.
## Functionality
- Twitter: Share two daily tweets about total market transactions and top 3 cryptocurrencies.
- Instagram: Share a weekly post about 10 most traded cryptocurrencies.
- Telegram: Share a daily post about 10 most traded cryptocurrencies.
### Cronjob
Cronjob is set to run specificly for each controller:
- Twitter: Every day at 8:00 & 9:00 PM.
- Instagram: Every Friday at 8:00 PM.
- Telegram: Every day at 9:01 PM.
You can change cronjob settings from serverless.yml file.
## Contributing
Pull requests are welcome! Feel free to open issues for any improvements or bugs.
## License
This project is open source and available under the [MIT License](https://opensource.org/licenses/MIT).