Build your first Hello, World 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 on the board with the text Hello, World!.
If you've never built a Miro app before, you're in the right place: let's get started!
Before you begin, ensure that you have the following prerequisites:
- You have a Developer team.
- Your development environment includes Node.js 14.15 or a later version.
- To run your app locally, your web browser must allow the HTTP transport protocol.
Recommended web browser: Google Chrome
Apple Safari doesn't allow HTTP; therefore, it doesn't allow the sample app to run locally.
Step 1: bootstrap the hello world app
Video 1. Run the command to create the sample app, and then click the link to review the preconfigured app options in the app settings UI.
Open the terminal and run:
npx [email protected]
Give your app a name, or press
Enter ↩to use the default app name:
Select your framework.
If you're creating an app that uses only the Web SDK, select one of these options:
If you're creating an app that also features a backend, select one of these options:
Miro Node Client Library with Express: includes the Miro Node.js client library; optimized for the Express web framework.
Next.js framework with Web SDK and API client installed: includes the Miro Node.js client library; optimized for the Next.js framework.
Select your flavor.
Choose one of the following options:
Once the app is created, click the link displayed in the terminal.
Figure 1. The terminal displays a link and a message: Create your preconfigured app in Miro by clicking on the following link.
It points to the app settings UI, where you can:
i. Create the app by clicking the Create app button on the Create new app modal.
ii. Check the preconfigured options in the app settings UI.
iii. Click Install app and get OAuth token to install the app to a team.
In the terminal, go to the
my-miro-appis the application name that you set in step 1.
Figure 2. In the app project root directory, use npm commands to install dependencies, build the app, and start running the app.
To start the app and begin developing, run:
Open your browser, paste the URL you just copied in step 7, and press
A message indicating that your app is now running locally appears.
Figure 1. Your app is running locally.
Step 2: try out your app in Miro
Open your Miro dashboard. Click the Dev team (DT icon on the left pane), and then click New board.
If the Template Picker appears, close the window.
Click >> or ... on the toolbar on the left side of the board, and then click Hello World.
You should see a sticky note, with the text Hello, World, on the board.
You did it!
Congratulations on building your first Miro app. The Miro Developer Platform allows you to create all kinds of fun, useful apps and integrations. It’s flexible enough to let you build what you want while being powerful enough to support essential workflows for you and your team.
We have many more examples of other apps and ideas you can build check Miro App Examples to find more.
Here's a list of topics you may want to check out:
- Get acquainted with fundamental concepts about Miro platform development.
- Learn how to create and interact with items on the board.
- Look through our Web SDK reference to get ideas about what to build next.
- Explore our design guidelines and best practices that dive into the details of building good Miro apps that help you provide a great user experience.
- When you're ready to take your app from development to deployed, you'll want to know more about how to submit your app.
Updated about 1 month ago
Learn how to reflect on the board updates to board item properties by syncing the changed board items.