Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samarth30/messaging-ai-agent
https://github.com/samarth30/messaging-ai-agent
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/samarth30/messaging-ai-agent
- Owner: samarth30
- Created: 2024-12-18T12:05:59.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T10:41:25.000Z (13 days ago)
- Last Synced: 2025-01-23T11:32:19.846Z (13 days ago)
- Language: JavaScript
- Size: 28.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Environment Configuration and Setup Guide
This document outlines the steps to configure and run the project with required and optional environment variables for API integration and functionality.
---
## Environment Variables
### For Twitter API v1 Support
Set the following environment variables in your `.env` file or environment configuration tool:
```plaintext
TWITTER_USERNAME= # Twitter account username
TWITTER_PASSWORD= # Twitter account password
TWITTER_EMAIL= # Twitter account email
TWITTER_COOKIES= # Twitter session cookies
```
### For Twitter API v2 Support
For using Twitter API v2, configure these environment variables:
```plaintext
TWITTER_API_KEY=key # Twitter API key
TWITTER_API_SECRET_KEY=secret # Twitter API secret key
TWITTER_ACCESS_TOKEN=token # Twitter access token
TWITTER_ACCESS_TOKEN_SECRET=tokensecret # Twitter access token secret
```
```plaintext
PROXY_URL= # HTTP(s) proxy for requests
OPENAI_API_KEY= # OpenAI API key for integration
DISCORD_USER_TOKEN= # Discord user token
DISCORD_USER_NAME= # Discord username
DISCORD_COOKIES= # Discord session cookies
```
---
## Setup Instructions
### Prerequisites
1. Ensure you have [Node.js](https://nodejs.org/) installed on your system.
2. Clone the repository and navigate to the project directory.
### Steps to Setup
1. Install the required dependencies by running:
```bash
npm install
```
2. Create a `.env` file in the root directory and populate it with the environment variables listed above.
---
## Running the Project
### Running Discord Integration
To run the Discord integration, use the following command:
```bash
node src/discord.js --characters=src/characters/shaw.character.json
```
### Running Twitter Integration
To run the Twitter integration, use this command:
```bash
node src/twitterDmAutomation.js --characters=src/characters/shaw.character.json
```
To run the Twitter retweet functionality, use this command:
```bash
node src/twitter.js
```
---
## Notes
- Ensure that the `.env` file is properly configured before running any commands.
- The `shaw.character.json` file should contain the configuration for the characters used in the integration. Replace this file path with your desired character configuration if needed.
- Use a valid proxy URL if you encounter network restrictions or need to route traffic through a proxy.
---