Shortzz - TikTok Clone Application

A full-featured TikTok clone with short videos, live streaming, PK battles, stories, and social features built with Flutter and Laravel.

🎯 Features

Core Features

• 📹 Short Video Sharing - Create and share short-form videos with filters
• 🎬 Reels & Feed - Infinite scroll video feed with engagement features
• 📺 Live Streaming - Go live with real-time viewer interaction
• ⚔️ PK Battles - Live streaming battles between creators
• 📖 Stories - 24-hour ephemeral content
• 💬 Real-time Chat - Direct messaging with media sharing
• 🎭 AR Filters - DeepAR powered effects and filters
• 🎵 Music Library - Add trending sounds to videos
• 💰 Monetization - Virtual gifts, coins, and wallet system
• 🔔 Push Notifications - Real-time activity notifications

Additional Features

• 👤 User profiles with follow/following system
• ❤️ Like, comment, share, and save posts
• 🔍 Search users, hashtags, and content
• 📍 Location-based content
• 🎁 Virtual gifts and tipping
• 💎 Premium subscriptions
• 🛡️ Content moderation
• 📊 Admin dashboard

🚀 Tech Stack

Mobile App (Flutter)

• Framework: Flutter 3.5.4+
• State Management: GetX
• Video: video_player, video_compress
• Live Streaming: Zego Express SDK
• AR Filters: DeepAR
• Chat: Firebase Firestore
• Authentication: Firebase Auth
• Payments: RevenueCat
• Ads: Google AdMob

Backend (Laravel)

• Framework: Laravel 10
• PHP: 8.1+
• Database: MySQL
• Storage: Local/AWS S3
• Push Notifications: Firebase Cloud Messaging
• Authentication: JWT via Laravel Sanctum

📋 Prerequisites

For Flutter App

• Flutter SDK 3.5.4 or higher
• Dart SDK
• Android Studio / Xcode
• Firebase project
• Zego account (for live streaming)
• DeepAR license (for AR filters)

For Laravel Backend

• PHP 8.1 or higher
• Composer
• MySQL 5.7+ / MariaDB 10.3+
• Node.js & NPM
• Web server (Apache/Nginx)

🛠️ Installation

Step 1: Clone the Repository

git clone <repository-url>
cd TikTokClone

Step 2: Database Setup

1. Create a MySQL database
2. Import the database schema:

mysql -u username -p database_name < shortzz_database.sql

Step 3: Backend Setup

1. Navigate to backend directory:

cd shortzz_backend

2. Install PHP dependencies:

composer install

3. Install Node dependencies:

npm install

4. Configure environment:

cp .env.example .env

5. Edit .env file with your configuration:

DB_DATABASE=your_database
DB_USERNAME=your_username
DB_PASSWORD=your_password

# Firebase credentials path
FIREBASE_CREDENTIALS=googleCredentials.json

# AWS S3 (optional)
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=
AWS_BUCKET=

6. Generate application key:

php artisan key:generate

7. Run migrations:

php artisan migrate

8. Build assets:

npm run prod

9. Start the server:

php artisan serve

Step 4: Flutter App Setup

1. Navigate to Flutter directory:

cd ../Shortzz

2. Install Flutter dependencies:

flutter pub get

3. Configure Firebase:

   • Place google-services.json in android/app/
   • Place GoogleService-Info.plist in ios/Runner/

4. Update configuration in lib/utilities/const_res.dart:

static const String baseUrl = "YOUR_BACKEND_URL";
static const String zegoAppId = "YOUR_ZEGO_APP_ID";
static const String zegoAppSign = "YOUR_ZEGO_APP_SIGN";
static const String deepArAndroidKey = "YOUR_DEEPAR_KEY";
// ... other configurations

5. Run the app:

flutter run

📱 Building for Production

Android

flutter build apk --release
# or for App Bundle
flutter build appbundle --release

iOS

flutter build ios --release

🔧 Configuration

Admin Panel

Access the admin panel at: http://your-backend-url/login

Default credentials (change after first login):

• Username: Check database tbl_admin table
• Password: As configured during setup

Key Configuration Areas

1. App Settings (Admin Panel)

   • App name and branding
   • Feature toggles (live streaming, stories, etc.)
   • Monetization settings
   • Content moderation rules

2. Third-party Services

   • Firebase project configuration
   • Zego Express credentials
   • DeepAR license keys
   • Payment gateway setup
   • AdMob configuration

📂 Project Structure

TikTokClone/
├── Shortzz/                 # Flutter mobile app
│   ├── lib/
│   │   ├── screen/         # UI screens
│   │   ├── model/          # Data models
│   │   ├── common/         # Shared utilities
│   │   └── main.dart       # App entry point
│   ├── android/            # Android specific files
│   ├── ios/                # iOS specific files
│   └── pubspec.yaml        # Flutter dependencies
│
├── shortzz_backend/         # Laravel backend
│   ├── app/                # Application logic
│   ├── routes/             # API routes
│   ├── resources/          # Views and assets
│   ├── database/           # Migrations and seeds
│   └── public/             # Public assets
│
└── shortzz_database.sql    # Database schema

🧪 Testing

Flutter Tests

cd Shortzz
flutter test
flutter analyze

Laravel Tests

cd shortzz_backend
php artisan test

🚨 Troubleshooting

Common Issues

1. Build failures

   • Clean and rebuild: flutter clean && flutter pub get
   • Clear Laravel caches: php artisan cache:clear

2. API connection issues

   • Verify backend URL in const_res.dart
   • Check CORS configuration in Laravel

3. Firebase errors

   • Ensure Firebase configuration files are in place
   • Verify Firebase project settings match app bundle ID

4. Live streaming not working

   • Verify Zego credentials
   • Check network permissions

📝 Documentation

• Flutter Documentation
• Laravel Documentation
• Firebase Documentation
• Zego Documentation

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License

This project is proprietary software. All rights reserved.

💬 Support

For support, please contact the development team or raise an issue in the repository.

See detailed changelog in:

• Shortzz/README.md - Flutter app changes
• shortzz_backend/README.md - Backend changes