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

Step 1: Bootstrap the app

  1. Open the terminal and run:

    npx create-miro-app@latest
    
  2. Provide a name for your app or press Enter to use the default name (my-miro-app).

  3. Select Miro Node Client Library with Express as the framework.

  4. 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:

  1. 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.

  2. In the Create new app form:

    1. Type the App name.
    2. Select your Developer team.
    3. Select the Expire user authorization token option.
    4. Select Create app.
  3. In the App Credentials section, copy the Client ID and Client Secret values.

  4. In your app folder, update the .env file with your app credentials.

  5. For MIRO_REDIRECT_URL, use http://localhost:3000/auth/miro/callback.

Step 3: Install the app

  1. In the Miro Developer Dashboard, select Install app and get OAuth token.
  2. Select your Developer team.
  3. Select Add.

Step 4: Run the app

  1. From the app folder, start the app by running:

    npm run start
    
  2. In your browser, navigate to http://localhost:3000.

You should see a list of boards you have available in Miro.