Quick start

Canva's app development platform lets anyone create apps that add features to Canva. This quick start guide explains how to get an app up and running in a matter of minutes.

Prerequisites

• You have a Canva.com account.
• You're familiar with TypeScript, React, and webpack.

Requirements

• git
• Node.js v18

Step 1: Create an app via the Developer Portal

1. Log in to the Developer Portal.
2. Navigate to the Your apps page.
3. Click Create an app.
4. Select a target audience for the app:
   • Public: You can make your app available to all of Canva's users, but the app will need to be reviewed by Canva and meet the requirements outlined in the submission checklist.
   • Restrict to your team: The app can only be made available to members of the current team and the team's administrators are responsible for reviewing it.
5. Agree to the terms and conditions.
6. Click Create.

Step 2: Set up the starter kit

1. Clone the starter kit:

   git clone https://github.com/canva-sdks/canva-apps-sdk-starter-kit.git

2. Navigate into the starter kit:

   cd canva-apps-sdk-starter-kit

3. Install the dependencies:

   npm install

4. Start the local development server:

   npm run start

The local development server becomes available at http://localhost:8080.

Step 3: Preview the app

1. Navigate to the app’s Configure your app page.
2. Select App source > Development URL.
3. In the Development URL field, enter the URL of the development server.
4. Click Preview to open the app in a new tab.
5. Click Use to install the app.

The app will load in the object panel of the Canva editor.

Next steps

Now that your app is up and running, the next step is to start developing it:

• To jump straight into the code, start editing the src/app.tsx file.
• To learn more about the Apps SDK, see Integrating with Canva.