Node.js - Clone GitHub Project - Node.js

This guide walks you through cloning and running a pre-built CreativeEditor SDK (CE.SDK) Node.js integration project from GitHub. It’s the fastest way to get started with CE.SDK in Node.js without having to set everything up from scratch.

Who Is This Guide For?#

This guide is perfect for developers who:

Want to use CE.SDK on a server without needing a custom setup.
Prefer working with a ready-to-go Node.js sample project.
Are comfortable using Git and Node.js to manage local development environments.

What You’ll Achieve#

Clone the CE.SDK Node.js integration project from GitHub.
Install the required dependencies and run the project locally.
Programmatically load a scene with CE.SDK CreativeEngine and export as PNG.

Prerequisites#

Before getting started, ensure you have the following:

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

Step 1: Clone the GitHub Repository#

Begin by cloning the CE.SDK examples repository from GitHub:

Git

GitHub CLI

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

bash gh repo clone imgly/cesdk-web-examples

Step 2: Install the Dependencies#

Navigate to the example directory:

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

Next, install the necessary dependencies using npm:

npm install

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

Step 3: Add Your License Key#

Open index.js and replace the placeholder license key with your valid one.

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

Step 4: Run the Project#

Run the Node.js script that contains your CreativeEngine logic with:

node index.js

This loads an existing scene and generates an image file named example-output.png in your project directory.

Troubleshooting & Common Issues#

❌ Issue: Module not found or missing packages

Verify that npm install ran without any errors and all dependencies were installed correctly.

❌ Error: Invalid license key

Confirm that the license key is correctly entered and valid.

Next Steps#

Congratulations! You’ve successfully integrated CE.SDK with Node.js. When you’re ready, dive deeper into the SDK and continue with the next steps: