Clipping System Requirements Document

1. Introduction

The "Clipping" project is a professional marketplace platform designed for video creators to submit their work for brand campaigns and earn based on views and commission. This document outlines the system requirements for the development of the Clipping platform, focusing on the core architecture, database models, payment logic, and backend scaffolding.

2. System Overview

The Clipping platform facilitates interactions between advertisers/brands, creators, and admins. Advertisers post campaigns with specific budgets and requirements, creators submit their video clips for these campaigns, and admins manage the platform's operations, including campaign approvals and commission rate adjustments. The platform supports both crypto (USDT) and fiat (PayPal) payout methods to ensure flexibility and convenience for creators.

3. Functional Requirements

• As an Advertiser, I should be able to post campaigns with a budget and specific requirements.
• As a Creator, I should be able to browse available campaigns and submit my video clips for consideration.
• As an Admin, I should be able to approve or reject submitted content from creators.
• As a Creator, I should be able to track the performance of my submitted clips.
• As a Creator, I should be able to receive payouts via USDT or PayPal based on views and commission.
• As an Admin, I should be able to view a revenue dashboard displaying the top-10 earners.
• As an Admin, I should be able to adjust the platform commission rate from the dashboard.
• As a User, I should receive in-app notifications about updates and changes via a notification center.

4. User Personas

• Advertiser/Brand: Posts campaigns, sets budgets, and reviews submitted content.
• Creator: Submits video clips, tracks performance, and receives earnings.
• Admin: Manages platform operations, approves content, and oversees financial transactions.

5. Core User Flows

• Advertiser posts campaign -> Creator submits content -> Admin/Brand approves -> Creator earns based on views -> Payouts triggered.
• Admin adjusts commission rate -> Revenue dashboard updates -> Top earners displayed.
• Creator receives notification -> Views campaign updates -> Submits new content.

6. Visuals Colors and Theme

• primary: #1E1E2F (Dark Indigo)
• primary_light: #2E2E4F (Lighter Indigo)
• secondary: #FF6F61 (Coral)
• accent: #FFD700 (Gold)
• highlight: #FFA500 (Orange)
• bg: #121212 (Dark Background)
• surface: rgba(30, 30, 47, 0.8)
• text: #FFFFFF (White)
• text_muted: #B0B0B0 (Muted Gray)
• border: rgba(255, 255, 255, 0.2)

7. Signature Design Concept

The Clipping platform will feature a dynamic, interactive homepage that resembles a digital film reel. As users scroll, the reel animates, showcasing featured campaigns and top creators. Each "frame" of the reel is clickable, allowing users to dive deeper into specific campaigns or creator profiles. This immersive experience will be powered by framer-motion for smooth animations and transitions, creating an engaging and memorable first impression.

8. Interaction Model & Motion Direction

The landing page will utilize a "parallax" interaction model, providing a layered depth effect as users scroll. This will enhance the storytelling aspect of the platform, with decorative elements moving at different speeds to create a sense of depth. Internal pages, such as dashboards and settings, will adopt a "static" model to prioritize clarity and ease of use.

9. Non-Functional Requirements

• The platform must ensure secure and reliable payment processing for both USDT and PayPal.
• The system should support high availability and scalability to handle increasing user loads.
• Data privacy and protection must be maintained in compliance with relevant regulations.

10. Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB with alembic for migrations
• Payment Integration: CoinPayments for USDT, PayPal Payouts API
• AI Tools: Not applicable
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

11. Assumptions and Constraints

• The platform will primarily target video creators and advertisers in the Indian market.
• The default commission rate is set at 20%, adjustable by the admin.
• The system will initially support English as the primary language.

12. Glossary

• USDT: A type of cryptocurrency known as Tether, pegged to the US dollar.
• PayPal Payouts API: A service that allows businesses to send payments to multiple recipients.
• CoinPayments: A cryptocurrency payment gateway service.
• Parallax: An effect where background images move slower than foreground images, creating a 3D effect.
• Framer-motion: A library for creating animations in React applications.