🎙️ Download and transcribe X Spaces effortlessly 🎙️

📝 Overview   •   💻 Tech Stack   •   🚀 Getting Started

📝 Overview

Spaces Companion is a powerful platform that enables users to download spaces from X.com (formerly Twitter) and generate transcriptions. The platform is built with a modern tech stack and follows a separated backend-frontend architecture. The frontend is based on the next-saas-starter template, while the backend is powered by an Express API.

💻 Tech Stack

• ✅ Framework: Next.js with TypeScript
• ✅ Database ORM: Drizzle
• ✅ Database: PostgreSQL (Neon)
• ✅ UI Components: shadcn/ui
• ✅ Payments: Stripe Integration
• ✅ Runtime: Node.js with Express
• ✅ Automation: Puppeteer
• ✅ Transcription: Groq (Whisper)

🚀 Getting Started

Backend Setup

1. Navigate to the backend directory:

cd backend

2. Create a .env file with the following variables:

TWITTER_USERNAME=
TWITTER_PASSWORD=
TWITTER_PHONE_NUMBER=
OUTPUT_PATH=./downloads
PORT=3000
DATABASE_URL=
FRONTEND_URL=http://localhost:3001

Note: You will need ffmpeg added to your environment variables [https://www.ffmpeg.org/download.html]. Note: It's recommended to create a new X account without two-factor authentication for the bot.

3. Install dependencies and start the server:

npm install
npm build
npm link
npm start

Frontend Setup

1. Navigate to the frontend directory:

cd frontend

2. Create a .env file with the following variables:

POSTGRES_URL=
STRIPE_SECRET_KEY=
STRIPE_WEBHOOK_SECRET=
BASE_URL=http://localhost:3001
AUTH_SECRET=
GROQ_API_KEY=
NEXT_PUBLIC_API_URL=http://localhost:3000

3. Install dependencies and start the development server:

pnpm install
pnpm db:generate
pnpm db:seed
pnpm db:migrate
pnpm dev

The application should now be running at:

• Frontend: http://localhost:3001
• Backend: http://localhost:3000