Docs
API Docs

Getting Started - Rails

Let’s get started!

This guide was based on version 6 of Rails and we will be using rails for simplicity.

Create a project
  • Start a new project by following the rails prompts
rails new my-app
cd my-app
rails s
  • Then open http://localhost:3000/ to see your app.
Installing peer dependencies

PhotoEditor SDK needs following peer dependencies:

  1. React >= 16.8.6
  2. React DOM >= 16.8.6
  3. Styled Components >= 4.4
  • Run yarn add react react-dom styled-components to include them in the project.
Installing PhotoEditor SDK
  • Run yarn add photoeditorsdk.

You will be left with following structure in your node_modules/photoeditorsdk/

├── assets
│   ├── adjustment
│   ├── colorpicker
│   ├── controls
│   ├── filter
│   ├── focus
│   ├── font
│   ├── frame
│   ├── overlay
│   ├── sticker
│   ├── textdesign
│   └── transform
├── esm
└── cjs

The package contains three folders that you need to integrate to your project.

  1. assets: It contains all assets required for the PhotoEditor, this includes for example assets for frames, stickers and the ui.
  2. cjs: It contains PhotoEditor SDK UI bundled as commonjs modules, will be loaded for older browser versions.
  3. esm: It contains PhotoEditor SDK UI bundled as ECMAScript modules, will be loaded for supported modern browser versions.
  • Copy the assets from node_modules/photoeditorsdk to public.
Creating an Editor component

Use the rails to generate the scaffold for your controller.

rails generate controller home index

Then file can be accessed with http://localhost:3000/home/index.

app/views/home/index.html.erb
<!-- PESDK Demo Integration -->
<div
  id="pesdk"
  style="width: 100vmin; height: 75vmin; padding: 0px; margin: 0px"
></div>
app/javascript/packs/application.js
...
import { PhotoEditorSDKUI } from 'photoeditorsdk'

window.onload = function () {
  PhotoEditorSDKUI.init({
    license: 'license-string', // <-- Please replace this with the content of your license file. The JSON-object must be in string format.
    container: '#pesdk',
    image: './example.jpg'
  })
}
...

CORS

If you are loading images from external sources (e.g. from an AWS bucket), you need to first configure Cross-Origin Resource Sharing for both the server and the image.

Otherwise, you will see errors such as
Failed to execute 'texImage2D' on 'WebGLRenderingContext': The cross-origin image at [...] may not be loaded.
or
Unable to get image data from canvas because the canvas has been tainted.

Please follow the instructions on how to properly configure CORS here.

Ready to go!

There you have it. PhotoEditor SDK for the Web is ready to use. Refer to the configuration documentaion for more configuration options.