stickynotes-to-shapes

Miro Sticky Notes to Shapes App

This app shows how you can select items on the board, and then click the app icon to change the selected sticky notes into shapes.

👨🏻‍💻 App Demo

📒 Table of Contents

• Included Features
• Tools and Technologies
• Prerequisites
• Associated Developer Tutorial
• Run the app locally
• Folder Structure
• Contributing
• License

⚙️ Included Features

• Miro Web SDK
  • getSelection()
  • remove()
  • createShape()

🛠️ Tools and Technologies

• React
• TypeScript
• Vite

✅ Prerequisites

• You have a Miro account.
• You're signed in to Miro.
• Your Miro account has a Developer team.
• Your development environment includes Node.js 14.13 or a later version.
• All examples use npm as a package manager and npx as a package runner.

📖 Associated Developer Tutorial

To view a more in depth developer tutorial of this app (including code explanations) see the Convert sticky notes to shapes tutorial on Miro's Developer documentation.

🏃🏽‍♂️ Run the app locally

1. Run npm install to install dependencies.

2. Run npm start to start developing.
   Your URL should be similar to this example:

   http://localhost:3000
   

3. Open the app manifest editor by clicking Edit in Manifest.
   In the app manifest editor, configure the app as follows:

   • sdkUri: assign http://localhost:3000 as a value for this property.
     It defines the entry point of the app, and it corresponds to the URL of the server that the app runs on.
   • scopes: add the permission scopes that users need to grant the app when they install it.
     To enable the app to read from and write to the board, add the following permissions:
     • boards:read
     • boards:write

4. Go back to your app home page, and under the Permissions section, you will see a blue button that says Install app and get OAuth token. Click that button. Then click on Add as shown in the video below. In the video we install a different app, but the process is the same regardless of the app.

⚠️ We recommend to install your app on a developer team while you are developing or testing apps.⚠️

install-app.mov

5. Go to your developer team, and open your boards.
6. Click on the plus icon from the bottom section of your left sidebar. If you hover over it, it will say More apps.
7. Search for your app Sticky Notes to Shapes or whatever you chose to name it. Click on your app to use it, as shown in the video below. In the video we search for a different app, but the process is the same regardless of the app.

search-for-app.mov

🗂️ Folder structure

.
├── src
│  └── index.js <-- The code for the entry point lives here. For this app, all the logic is contained here.
└── index.html <-- The app entry point. This is the value you assign to 'sdkUri' in the app manifest file.

🫱🏻‍🫲🏽 Contributing

If you want to contribute to this example, or any other Miro Open Source project, please review Miro's contributing guide.

🪪 License

MIT License.