CLAUDE.md

Project Overview

This project, social-auto-upload, is a powerful automation tool designed to help content creators and operators efficiently publish video content to multiple domestic and international mainstream social media platforms in one click. The project implements video upload, scheduled release and other functions for platforms such as Douyin, Bilibili, Xiaohongshu, Kuaishou, WeChat Channel, Baijiahao and TikTok.

The project consists of a Python backend and a Vue.js frontend.

Backend:

• Framework: Flask
• Core Functionality:
  • Handles file uploads and management.
  • Interacts with a SQLite database to store information about files and user accounts.
  • Uses playwright for browser automation to interact with social media platforms.
  • Provides a RESTful API for the frontend to consume.
  • Uses Server-Sent Events (SSE) for real-time communication with the frontend during the login process.

Frontend:

• Framework: Vue.js
• Build Tool: Vite
• UI Library: Element Plus
• State Management: Pinia
• Routing: Vue Router
• Core Functionality:
  • Provides a web interface for managing social media accounts, video files, and publishing videos.
  • Communicates with the backend via a RESTful API.

Command-line Interface:

The project also provides a command-line interface (CLI) for users who prefer to work from the terminal. The CLI supports two main actions:

• login: To log in to a social media platform.
• upload: To upload a video to a social media platform, with an option to schedule the upload.

Building and Running

Backend

1. Install dependencies:

   pip install -r requirements.txt
   

2. Install Playwright browser drivers:

   playwright install chromium
   

3. Initialize the database:

   python db/createTable.py
   

4. Run the backend server:

   python sau_backend.py
   

   The backend server will start on http://localhost:5409.

Frontend

1. Navigate to the frontend directory:

   cd sau_frontend
   

2. Install dependencies:

   npm install
   

3. Run the development server:

   npm run dev
   

   The frontend development server will start on http://localhost:5173.

Command-line Interface

To use the CLI, you can run the cli_main.py script with the appropriate arguments.

Login:

python cli_main.py <platform> <account_name> login

Upload:

python cli_main.py <platform> <account_name> upload <video_file> [-pt {0,1}] [-t YYYY-MM-DD HH:MM]

Development Conventions

• The backend code is located in the root directory and the myUtils and uploader directories.
• The frontend code is located in the sau_frontend directory.
• The project uses a SQLite database for data storage. The database file is located at db/database.db.
• The conf.example.py file should be copied to conf.py and configured with the appropriate settings.
• The requirements.txt file lists the Python dependencies.
• The package.json file in the sau_frontend directory lists the frontend dependencies.