Starter kit
A starter kit is a GitHub repository that contains the boilerplate of a working app, along with the tooling that Canva recommends for building one. Cloning a starter kit is the quickest route to a running app, and the documentation assumes that you're using the kit for the surface you're building for.
There is one starter kit per surface. To clone, configure, and run either of them, see Quickstart and choose your surface.
The starter kits for apps inside Canva (previously known as the Apps SDK) and the Canva REST APIs (previously known as the Connect APIs) are being combined in a future update. The steps here continue to work until that happens, and will be updated in the future.
Apps inside Canva
The starter kit for apps inside Canva(opens in a new tab or window) includes:
- An app's boilerplate, with
src/app.tsxas its entry point. - The App UI Kit, so that your app matches the look and feel of Canva.
- TypeScript(opens in a new tab or window), React(opens in a new tab or window), and
@canva/app-scripts. - An
examplesdirectory of usage examples for the APIs. - An example backend(opens in a new tab or window), built with Express.js, that some of the examples rely on.
The kit also simplifies generating the JavaScript bundle that you upload to Canva.
Canva for your platform
The starter kit for the Canva REST APIs(opens in a new tab or window) includes:
- A React-based e-commerce web app.
- An Express.js backend with a mock product database.
- A working REST API client.
- A working authentication flow.
The reference apps are built from this kit's demos.