Create a Miro app

The easiest way to get started with the Miro Developer Platform is by using create-miro-app.
To get started, run the following command:

npx create-miro-app@latest

To create a new app in a specific folder, you can send a name as an argument.
For example, the following command will create a new Miro app called my-miro-app in a folder with the same name:

npx create-miro-app@latest my-miro-app

Options

You can append the following options to npx create-miro-app@latest to run the installation in a silent, non-interactive mode.

If you don't append any options, you'll be prompted to specify app name and package manager interactively.

| Name | Description | | ------------- | ----------------------------------------------------------------------------------------------------------- | | [name] | Sets the name of the app.Default: my-miro-app | | --npm | Bootstraps the project using npm.Default: yarn, if installed. | | --framework | Sets the framework template to use.One of: vanilla, react, preact, vue, nextjs or express | | --flavour | Sets the language template to use.One of: js, ts |

Analytics

create-miro-app collects completely anonymous analytics data about framework and language usage. To opt-out, set the following environment variable: DO_NOT_TRACK=1

See also

• 💡 The Build your first Hello, World app tutorial guides you through the process step by step.

Prerequisites

You need to have node >= 20

nvm use