Build a Web SDK app
The Miro Web SDK sample app includes boilerplate and scaffolding to make it fast and easy to run a Miro app on a board.
This tutorial shows you how to get a simple app running in Miro using the Miro Web SDK. By the end of this guide, you'll have built an app that displays a sticky note with the text "Hello, World!" on the board.
If you've never built a Miro app before, you're in the right place. Let's get started!
Prerequisites
- You have a Developer team.
- Your development environment includes Node.js 14.15 or a later version.
Step 1: Bootstrap the app
-
Open the terminal and run:
npx create-miro-app@latest
-
Provide a name for your app or press Enter to use the default name (my-miro-app).
-
Select your framework: Preact, React, Vanilla, Vue.
-
Select your flavor: JavaScript or TypeScript.
The CLI will create a new app in the current directory.
Success!
Created my-miro-app at /Users/username/my-miro-app
Create your preconfigured app in Miro by clicking on the following link:
https://miro.com/app/settings/user-profile/apps/?appTemplate=%7B%22appName%22%3A%22...
Inside the app directory, you can run several commands.
Start the development server:
npm run start
To build your app:
npm run build
We suggest that you begin by typing:
cd frontend-app
npm run start
Step 2: Set up the app
- After the app is created, copy the link displayed in the terminal and paste it into your browser. This link will take you to the Miro Developer Dashboard, where you can create a new app.
- In the Create new app form:
- Type the App name.
- Select your Developer team.
- Select Create app.
Step 3: Install the app
- In the Miro Developer Dashboard, select Install app and get OAuth token.
- Select your Developer team.
- Select Add.
Step 4: Run the app
-
Go to the app folder:
cd my-miro-app
-
From the app folder, start the app by running:
npm run start
-
In Miro, go to the board where you want to install the app.
-
Select the Plus icon in the bottom-left corner, find and select your app in the list.
You should now see your Miro app and a sticky note saying "Hello, World!".
Updated about 1 month ago
If you app uses only the Miro Web SDK, and it doesn't need OAuth, you can make it easier and faster to install for your users.