Open Platter

Open Platter is an open-source application that allows you to connect your Twitter account, schedule posts, and generate tweets from text transcriptions using Azure OpenAI. It's built with Next.js and uses a local SQLite database for storage.

Features

• Twitter Integration: Connect your Twitter account using OAuth 1.0a.
• Post Scheduling: Schedule tweets to be posted at a future time.
• AI Tweet Generation: Upload a text file (.txt) and use Azure OpenAI to generate a series of suggested tweets based on the content.
• Batch Scheduling: Review, edit, and schedule the AI-generated tweets in bulk.
• Local Database: Uses a local SQLite database, so you can run it without any external database dependencies.
• Cron Job: A simple cron job script posts your scheduled tweets automatically.

Getting Started

Follow these instructions to get the project up and running on your local machine.

1. Prerequisites

• Node.js (v20.6.0 or later)
• npm
• A Twitter Developer Account
• An Azure Account with access to Azure OpenAI services.
• A Giphy Developer Account (optional, for GIF picker functionality)

2. Obtain Twitter Developer Keys

1. Apply for a Twitter Developer Account: If you don't have one, go to the Twitter Developer Portal and apply for access.
2. Create a Project and App: Once you have access, create a new Project and then create a new App within that project.
3. App Settings:
   • Find your App and go to its settings.
   • Under User authentication settings, set up OAuth 1.0a.
   • Set the App permissions to "Read and write".
   • In the Callback URI / Redirect URL field, add the following URL: http://localhost:3000/api/twitter/auth/callback
4. Get Keys and Tokens: Navigate to the "Keys and Tokens" tab for your App. Generate and copy your API Key and API Key Secret. These will be your TWITTER_API_KEY and TWITTER_API_SECRET.

3. Obtain Azure OpenAI Keys

1. Create an Azure OpenAI Resource: In the Azure Portal, create a new Azure OpenAI resource.
2. Deploy a Model: Once the resource is created, go to the Azure OpenAI Studio and deploy a new model (e.g., gpt-35-turbo or gpt-4). Take note of the deployment name.
3. Get Keys and Endpoint: In your Azure OpenAI resource page, navigate to the "Keys and Endpoint" section. Copy the API Key and the Endpoint URL.

4. Obtain Giphy API Key (Optional)

1. Create a Giphy Developer Account: Go to the Giphy Developers Portal and create an account.
2. Create an App: Create a new app to get your API key.
3. Copy API Key: Copy the API key for use in the environment variables.

5. Installation and Setup

1. Clone the repository:

   git clone <repository-url>
   cd open-platter

2. Install dependencies:

   npm install

3. Create a local environment file: Create a file named .env.local in the root of the project and add your keys:

   # Twitter API Keys (Required)
   TWITTER_API_KEY=your_twitter_api_key
   TWITTER_API_SECRET=your_twitter_api_secret
   
   # Azure OpenAI Keys (Required)
   AZURE_OPENAI_API_KEY=your_azure_openai_api_key
   AZURE_OPENAI_ENDPOINT=your_azure_openai_endpoint
   AZURE_OPENAI_DEPLOYMENT=your_azure_openai_deployment_name
   AZURE_OPENAI_API_VERSION=2025-01-01-preview
   
   # Giphy API Key (Optional - for GIF picker in scheduler)
   NEXT_PUBLIC_GIPHY_API_KEY=your_giphy_api_key

4. Set up the database: This command will create the sqlite.db file and run the necessary migrations to set up your tables.

   npm run db:push

6. Running the Application

1. Start the development server:

   npm run dev

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

2. Run the scheduler cron job: To have the application automatically post your scheduled tweets, you need to run the cron job script. Open a new terminal window and run:

   npm run cron:run

   This script will check for due posts every minute and send them to Twitter.

Environment Variables

Required Variables

Variable	Description	Where to obtain
TWITTER_API_KEY	Twitter API consumer key	Twitter Developer Portal → Your App → Keys and Tokens
TWITTER_API_SECRET	Twitter API consumer secret	Twitter Developer Portal → Your App → Keys and Tokens
AZURE_OPENAI_API_KEY	Azure OpenAI API key	Azure Portal → Your OpenAI Resource → Keys and Endpoint
AZURE_OPENAI_ENDPOINT	Azure OpenAI endpoint URL	Azure Portal → Your OpenAI Resource → Keys and Endpoint
AZURE_OPENAI_DEPLOYMENT	Azure OpenAI model deployment name	Azure OpenAI Studio → Your deployed model name
AZURE_OPENAI_API_VERSION	Azure OpenAI API version	Use 2025-01-01-preview or latest available

Optional Variables

Variable	Description	Where to obtain	Default/Fallback
NEXT_PUBLIC_GIPHY_API_KEY	Giphy API key for GIF picker	Giphy Developers Portal → Your App	Has fallback key