Skip to content

README.md

Latest commit

 

History

History
91 lines (63 loc) · 2.83 KB

README.md

File metadata and controls

91 lines (63 loc) · 2.83 KB
Raw

Photo Editor Starter Kit for iOS

Professional photo editing for your iOS app — apply filters, adjustments, cropping, and effects. Built with CE.SDK by IMG.LY.

Documentation | Live Demo

Getting Started

Prerequisites

  • Xcode
  • Swift 6+
  • iOS 16+ deployment target

Clone the Repository

git clone https://github.com/imgly/starterkit-photo-editor-ios.git
cd starterkit-photo-editor-ios

Open in Xcode

open StarterKit-PhotoEditor.xcodeproj

Xcode will resolve the Swift Package dependencies automatically. Select an iOS Simulator or device and press Run (Cmd+R).

Configuration

License Key

Add your CE.SDK license key in StarterKit-PhotoEditor/Secrets.swift:

let secrets = Secrets(
  // ...
  licenseKey: "your-license-key"
)

Without a license key, the editor runs in evaluation mode with a watermark.

Customization

The starter kit files in StarterKit/ demonstrate how to customize the editor:

  • Configuration — PhotoEditorConfiguration.swift
  • Callbacks — callbacks/ (onCreate, onChanged, onExport, onLoaded)
  • Components — components/ (navigation bar, dock, inspector bar, canvas menu)

Architecture

starterkit-photo-editor-ios/
├── StarterKit-PhotoEditor.xcodeproj/
├── StarterKit-PhotoEditor/
│   ├── StarterKit_PhotoEditorApp.swift  # @main entry point
│   ├── ContentView.swift               # Root view launching the starter kit
│   └── Secrets.swift                   # License key configuration
└── StarterKit/
    ├── PhotoEditorStarterKit.swift
    ├── PhotoEditorConfiguration.swift
    ├── callbacks/                      # Lifecycle callbacks
    └── components/                     # UI component customization

Key Capabilities

  • Filters — Professional photo filters and effects
  • Adjustments — Brightness, contrast, saturation, and more
  • Cutouts — Background removal and selective editing
  • Stickers — Add stickers and overlays
  • Text — Add text with typography controls
  • Export — PNG, JPEG with quality controls

Documentation

For complete integration guides and API reference, visit the CE.SDK iOS Documentation.

License

This project is licensed under the MIT License — see the LICENSE file for details.

Built with CE.SDK by IMG.LY