Clone GitHub Electron Project - Electron

This guide walks you through cloning and running a preconfigured CreativeEditor SDK (CE.SDK) Electron integration project from GitHub. It’s the quickest way to get started with CE.SDK without needing to set everything up from scratch.

Who Is This Guide For?#

This guide is for developers who:

Want to explore CE.SDK without the need to configure a custom setup.
Prefer working with a ready-to-go Electron sample project.
Are familiar with using Git and Node.js for managing local development environments.

What You’ll Achieve#

Clone the CE.SDK Electron integration project from GitHub.
Install the necessary dependencies and run the project locally.
Open a fully functional image and video editor right in your browser.

Prerequisites#

Before starting, make sure you have the following:

Git - Required to clone the project repository. Download Git.
The latest LTS version of Node.js and npm. Download Node.js.
A valid CE.SDK license key (Get a free trial).

Step 1: Clone the GitHub Repository#

Clone the CE.SDK examples repository from GitHub:

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

Then navigate to the Electron integration folder:

cd cesdk-web-examples/integrate-with-electron

Step 2: Install the Dependencies#

Install the required dependencies with npm:

npm install

This fetches and installs all the packages listed in the project’s package.json file.

Step 3: Add Your CE.SDK License Key#

Open the index.html file and replace the placeholder with your valid CE.SDK license key:

const config = {
  // license: 'YOUR_CESDK_LICENSE_KEY', // Replace with your CE.SDK license key
  // ...
};

Step 4: Run the Project#

Start the Electron development server by running:

npm run dev

The application with CE.SDK integration opens in a native window provided by Electron.

Troubleshooting & Common Issues#

❌ Error: 'electron' is not recognized as an internal or external command, operable program or batch file.

Ensure you’ve successfully run npm install before attempting npm run dev.

❌ Error: Invalid license key

Double-check that the license key is correctly added and valid.

Next Steps#

Congratulations! You’ve successfully set up CE.SDK with Electron. When you’re ready, explore the SDK further and move on to the next steps: