README-template.md

Create a Miro app

How to start locally

1. Sign in to Miro, and then create a Developer team under your user account.

2. Create an app in Miro.

• Click the Create new app button.
• On the Create new app modal, give your app a name, assign it to your Developer team, and then click Create.

3. Configure the app:

• In your account profile, go to Your apps, and then select the app you just created to access its configuration page.
• On the app configuration page, go to App Credentials, and copy the app Client ID and Client secret values: you'll need to enter these values in step 4 below.
• Go to App URL and enter the following URL: http://localhost:3000
• Go to Redirect URI for OAuth2.0, and enter the following redirect URL: http://localhost:3000/api/redirect
• Click Options.
  From the drop-down menu select Use this URI for SDK authorization.
• Lastly, go to Permissions, and select the following permissions:
  • board:read
  • board:write

4. Open the .env file, and enter the app client ID and client secret values that you saved at the beginning of step 3 above.
5. Run npm start to start developing.

When your server is up and running:

• Go to Miro.com.
• In your developer team, open a board.
• To start your app, click the app icon in the app toolbar on the left.