Search
Loading...
Skip to content

Node.js - Clone GitHub Project

This guide will walk you through cloning and running a pre-built CreativeEditor SDK (CE.SDK) Node.js integration project from GitHub. That’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 the server without the need for 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.
  • Start a creative editor process on a Node.js server.

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:

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

Step 2: Install the Dependencies#

Now, navigate to the example directory:

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

Next, install the necessary dependencies using npm:

Terminal window
npm install

This will download and install all the required packages listed in the project’s package.json file.

Step 3: Add Your CE.SDK License Key#

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

const config = {
  license: '<YOUR_CE_SDK_LICENSE>', // replace this with your CE.SDL license key
  // ...
};

Step 4: Run the Project#

Run the Node.js script that contains your creative editor logic by executing:

Terminal window
node index.js

The script will be executed, and you’ll see the result in the terminal.

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: