Flutter Clone GitHub Project

This comprehensive guide walks you through cloning and running the CE.SDK official Flutter sample project, which includes complete CreativeEditor SDK (CE.SDK) integration examples. By the end, you’ll have a fully functional Flutter application with multiple editor examples running on your device.

Who Is This Guide For?#

This guide is for developers who:

Want to explore working CreativeEditor SDK examples before implementing in their own project
Need to understand different integration patterns and use cases
Want to test the CreativeEditor SDK features with minimal setup
Are looking for reference implementations to learn from
Want to quickly get started with a pre-configured Flutter project

What You’ll Achieve#

By following this guide, you will:

Clone the official IMG.LY Flutter examples repository
Set up the project with your license key
Run multiple CreativeEditor SDK examples on your device
Explore different editor presets and configurations
Understand common integration patterns
Have a working reference implementation to learn from

View on GitHub

Explore Flutter Demos

Prerequisites#

Before you begin, ensure you have the following requirements:

Development Environment#

Flutter SDK: 3.16.0 or later
Dart SDK: 2.12.0 or later
Android Studio or VS Code with Flutter extensions
Git CLI for version control

Platform Requirements#

iOS: 16.0+ (Xcode 16.4+, Swift 6.1+)
Android: 7.0+ (API level 24+)

License#

A valid CE.SDK license key (Get a free trial), pass null to run in evaluation mode with watermark.

Verify Your Setup#

Run the following command to verify your Flutter installation:

flutter doctor

This command checks your Flutter installation and reports any issues to resolve before proceeding.

Step 1: Clone the GitHub Repository#

First, navigate to your preferred working directory:

# Navigate to your preferred directory
cd ~/Downloads  # or any directory of your choice

Clone the official IMG.LY Flutter examples repository:

git clone https://github.com/imgly/cesdk-flutter-examples.git
cd cesdk-flutter-examples

Repository Structure#

The cloned repository contains:

cesdk-flutter-examples/
├── showcases/           # Main Flutter app with multiple examples
├── shared/             # Shared configuration files
├── scripts/            # Build and deployment scripts
├── fastlane/           # CI/CD configuration
├── README.md           # Project documentation
└── pubspec.yaml        # Flutter dependencies

Step 2: Configure Your License Key#

The examples require a valid CreativeEditor SDK license key to function.

2.1 Locate the Secrets File#

Navigate to the main Flutter app directory:

cd showcases

The license configuration is in lib/secrets/secrets.dart:

class Secrets {
  // Enter your license here.
  static const String license =
      String.fromEnvironment("SHOWCASES_LICENSE_FLUTTER", defaultValue: "");
}

2.2 Set Your License Key#

You have two options for setting your license key:

Option A: Direct in secrets file (for testing) Since this is a cloned repository for testing, you can add your license key directly:

class Secrets {
  // Enter your license here.
  static const String license =
      String.fromEnvironment("SHOWCASES_LICENSE_FLUTTER", defaultValue: "your_actual_license_key_here");
}

Option B: Environment variable (recommended) Pass the license key as an environment variable when running:

flutter run --dart-define=SHOWCASES_LICENSE_FLUTTER=your_actual_license_key_here

Security Note: For production projects, always use environment variables or secure key management systems. Direct key placement is only recommended for testing and learning purposes.

Step 3: Install Dependencies#

Install the Flutter dependencies:

flutter pub get

This downloads and installs all required packages, including the CreativeEditor SDK.

Step 4: Configure Platform-Specific Settings#

The repository includes pre-configured platform settings, but you may need to verify them:

4.1 Android Configuration#

The Android configuration is already set up with:

Minimum SDK: 24
Kotlin version: 1.9.10
IMG.LY Maven repository
Required permissions

Verify the configuration by running:

cd android
./gradlew clean
cd ..

4.2 iOS Configuration#

The iOS configuration is already set up with:

Deployment target: 16.0
Required permissions (camera, microphone)
Swift support

Install iOS dependencies:

cd ios
pod install
cd ..

Step 5: Run the Examples#

Now you can run the Flutter examples on your device:

5.1 List Available Devices#

flutter devices

5.2 Run on Android Device#

# Run with license key
flutter run --dart-define=SHOWCASES_LICENSE_FLUTTER=your_actual_license_key_here

# Or run on specific device
flutter run -d your_device_id --dart-define=SHOWCASES_LICENSE_FLUTTER=your_actual_license_key_here

5.3 Run on iOS Device#

# Run with license key
flutter run --dart-define=SHOWCASES_LICENSE_FLUTTER=your_actual_license_key_here

# Or run on specific device
flutter run -d your_device_id --dart-define=SHOWCASES_LICENSE_FLUTTER=your_actual_license_key_here

Step 6: Explore the Examples#

The Flutter examples app repository includes multiple showcases demonstrating different CreativeEditor SDK features:

6.1 Available Examples#

The app contains examples for:

Photo Editing: Basic photo editing with filters and adjustments
Design Creation: Full-featured design editor for creating graphics
Video Editing: Video processing and editing capabilities
Apparel Design: T-shirt and merchandise design tools
Postcard Design: Greeting cards and postcard creation

Use the app’s navigation to explore different examples
Each example demonstrates specific CreativeEditor SDK features
Tap on examples to launch the editor with different presets
Test available editing capabilities and workflows

6.3 Learning from Examples#

Study the example implementations to understand:

How to integrate the CreativeEditor SDK
Different preset configurations
Result handling patterns
Error handling approaches
UI integration patterns

Step 7: Understand the Code Structure#

The examples demonstrate best practices for CreativeEditor SDK integration:

7.1 Key Files to Study#

lib/
├── main.dart              # App entry point
├── secrets/
│   └── secrets.dart       # License key configuration
├── services/
│   └── editor_service.dart # Editor integration service
├── screens/
│   └── showcases/         # Example screens
└── widgets/               # Reusable UI components

7.2 Integration Patterns#

The examples show different integration approaches:

Service-based integration: Centralized editor service
Screen-specific integration: Direct integration in screens
Preset variations: Different editor configurations
Result handling: Common ways to process editor results

Troubleshooting#

Common Issues and Solutions#

1. License Key Errors#

Error:

Invalid license key

Solution:

Ensure you have a valid license key from IMG.LY (or pass null for evaluation mode with watermark)
Verify the license key is correctly set in lib/secrets/secrets.dart
Check that the license key is for the correct platform (Flutter)
Ensure there are no extra spaces or characters in the license key

2. Build Errors#

Error:

Dependencies not found

Solution:

Run flutter pub get to install dependencies
Check your internet connection
Verify Flutter version compatibility

3. Platform-Specific Issues#

Android Issues:

cd android
./gradlew clean
cd ..
flutter run

iOS Issues:

cd ios
pod install
cd ..
flutter run

4. Device Connection Issues#

Error:

No devices found

Solution:

Ensure your device is connected and unlocked
Enable USB debugging (Android) or trust the computer (iOS)
Run flutter devices to verify device detection

Next Steps#

Now that you have the examples running, you can:

Study the Code: Examine the implementation patterns in the examples
Test Features: Try different editor presets and configurations
Customize Examples: Modify the examples to test your own use cases
Integrate into Your Project: Use the examples as reference for your own implementation
Explore Advanced Features: Test advanced editing capabilities

New Project Setup : Create a new Flutter project with CreativeEditor SDK
Existing Project Integration : Add CreativeEditor SDK to your existing Flutter app
Configuration Guide : Learn about advanced configuration options

Support#

If you encounter any issues or need assistance:

Check the troubleshooting section above
Review the Flutter examples for working implementations
Contact IMG.LY support for technical assistance

Congratulations! You’ve successfully cloned and are running the official CreativeEditor SDK Flutter examples. You now have a comprehensive reference implementation to learn from and test various CreativeEditor SDK features.

Who Is This Guide For?#

What You’ll Achieve#

Prerequisites#

Development Environment#

Platform Requirements#

License#

Verify Your Setup#

Step 1: Clone the GitHub Repository#

Repository Structure#

Step 2: Configure Your License Key#

2.1 Locate the Secrets File#

2.2 Set Your License Key#

Step 3: Install Dependencies#

Step 4: Configure Platform-Specific Settings#

4.1 Android Configuration#

4.2 iOS Configuration#

Step 5: Run the Examples#

5.1 List Available Devices#

5.2 Run on Android Device#

5.3 Run on iOS Device#

Step 6: Explore the Examples#

6.1 Available Examples#

6.2 Navigation#

6.3 Learning from Examples#

Step 7: Understand the Code Structure#

7.1 Key Files to Study#

7.2 Integration Patterns#

Troubleshooting#

Common Issues and Solutions#

1. License Key Errors#

2. Build Errors#

3. Platform-Specific Issues#

4. Device Connection Issues#

Next Steps#

Related Guides#

Support#