Clone GitHub Project

This guide walks you through downloading and running a prebuilt CreativeEditor SDK (CE.SDK) integration project hosted on GitHub. It’s the fastest way to explore how CE.SDK works without building anything from scratch.

Who is This Guide For?

This guide is for developers who:

Want to try out CE.SDK without setting up a custom environment.
Prefer working with an existing template or sample project.
Are comfortable using Git and Node.js to set up local projects.

What You’ll Achieve

Clone a working CE.SDK integration project from GitHub.
Install dependencies and run the project locally.
Launch a functional editor in your browser.

Prerequisites

Before getting started, ensure you have the following installed:

Git – Used to clone the GitHub repository. Download Git
Node.js (v14 or higher) and NPM – Required to run the local server. Download Node.js
A valid CE.SDK license key. You can start a free trial to obtain one.

Step 1: Clone the GitHub Repository

First, clone the CE.SDK examples repository from GitHub:

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

Then navigate to the Vanilla JS integration folder:

cd cesdk-web-examples/integrate-with-vanilla-js

Step 2: Install Dependencies

Once inside the project directory, install the necessary packages using NPM:

npm install

This will download all required modules as defined in the project’s package.json.

Step 3: Add Your License Key

Open the main configuration file (typically in index.js or .env depending on the setup) and replace the placeholder license key with your valid one.

const config = {
  license: 'YOUR_LICENSE_KEY',  // Replace with your actual key
  ...
};

Step 4: Run the Project

Use the project’s dev command to start a local development server. Most sample projects use Vite:

npm run dev

By default, the app will be available on your localhost at http://localhost:5000/.

Troubleshooting & Common Issues

❌ Module not found or missing packages

Double-check that you ran npm install successfully and there are no errors.

❌ Invalid license key

Make sure the license key is correctly added and valid.

Next Steps

Congratulations you’ve got CE.SDK up and running. Get to know the SDK and dive into the next steps, when you’re ready: