Build your first Hello World REST API app
This guide shows you how to create a Miro app leveraging the REST API.
This tutorial shows you how to get a simple app running in Miro using the Miro REST API. By the end of this guide, you'll have built an app that displays a list of boards you have available.
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 Miro Node Client Library with Express as the framework.
-
Select your flavor: TypeScript or JavaScript.
The CLI will create a new app in the current directory.
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 the Expire user authorization token option.
- Select Create app.
-
In the App Credentials section, copy the Client ID and Client Secret values.
-
In your app folder, update the .env file with your app credentials.
-
For
MIRO_REDIRECT_URL
, usehttp://localhost:3000/auth/miro/callback
.
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
-
From the app folder, start the app by running:
npm run start
-
In your browser, navigate to
http://localhost:3000
.
You should see a list of boards you have available in Miro.
Updated about 21 hours ago