If you have attended hackathons in the past, you know how much time it takes to get a project started. From that first second when you get thinking on what to build, to picking a programming language, and then deciding what framework to use—it doesn't end there, and the list goes on! That's why this page is here! These resources help you get started with minimal time and effort.
Happy hacking!
- Hackathon starter kit
-
New to the Miro Developer Platform? Interested in learning more about platform concepts?
Read our introduction page and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. -
Not sure about whether you should use the Miro Web SDK or the REST APIs?
Here's a table that provides helpful guidelines on Miro Web SDK and REST API usage.
- Quickstart (video): try the Web SDK in less than 1 minute.
- Quickstart (article): get started, try the Web SDK in less than 1 minute, and use the Miro Web SDK in the developer console to get acquainted with its feature set.
- Build your first Hello World app: bootstrap the Hello World app, create a Developer team in Miro, create and configure your app in Miro.
Check out our how-tos and step-by-step tutorials to walk you through typical use cases when working with the Miro Web SDK.
Look up methods, board item properties, and copy-paste code examples from the Miro Web SDK reference guide.
The Miro Node.js client is a JavaScript library that enables Miro REST API functionality in Miro apps based on Node.js. You can use Node.js and JavaScript to send requests to and handle responses from the Miro REST API. Here are some resources that might come handy:
- Miro NodeJs Client library doc
- Quickstart for task automation: a simple quick start guide to get up and running.
- Quickstart with OAuth and Express: a quick start guide to build a Node.js app with OAuth 2.0 authentication and a web server based on the Express web framework.
- Implement storage for data persistence: implement data storage in a Node.js app.
- Reference documentation: look up methods, interfaces, and properties.
- Quickstart (video): try the REST API in less than 3 minutes.
- Quickstart (article): get started and try the REST API in less than 3 minutes.
Check out our how-tos and step-by-step tutorials to walk you through typical use cases when working with the Miro REST API.
Clone our Miro App Examples repository to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.
| App Example | Description |
|---|---|
| csv-to-mindmap | Import data from CSV and create mind map on a Miro board |
| drag-and-drop | This example shows you how to drag and drop images from your app onto the board. |
| asset-search | This example shows you how to filter and search through assets by name and/or multiple tags. |
| digital-asset-manager | This example shows you how to build a digital asset manager using Bynder's API. |
| connect-firebase | This example shows you how to connect an SDK app to a Firebase backend. |
| stickynotes-to-shapes | This example allows you to select several stickies, click the plugin button in the bottom bar, and replace any selected stickies with shapes. |
| template-builder | This example shows how to create and position on the board multiple widgets of different types and render create custom interfaces in the library. |
| calendar | This example shows you how to add a calendar made with shapes and text for a given month and year. |
| wordle | This example shows you how to create a Wordle-like game using the Miro Web SDK. |
| blob-maker | This example shows you how to create a drag and drop blobmaker using Miro's Web SDK. |
| youtube-room | This example shows you how to sync a YouTube player across multiple users through Socket.IO. |
| custom-actions | This example shows you how register custom actions in the item context menu. |
| App Example | Description |
|---|---|
| python-oauth | This Python sample demonstrates how to implement the Oauth 2.0 authorization code flow in Miro. |
| node-oauth | This Node.js sample demonstrates how to implement the Oauth 2.0 authorization code flow in Miro and make an API request to a Miro endpoint. |
| node-passport-oauth | This Node.js sample demonstrates how to implement the Oauth 2.0 authorization code flow in Miro and make an API request to a Miro endpoint using Passport.js. |
| nextjs-oauth | This app demonstrates how to implement the Oauth 2.0 authorization code flow from Miro into a client side application built with Next.js. |
| node-stickies-csv | This Node.js sample app uses server side rendering (Handlebars.js) to provide a lightweight, CRUD-oriented REST example in the browser for Miro's sticky notes and tags APIs. It demonstrates a structured > unstructured use case via CSV import, creating Miro sticky notes with tags based on CSV data. |
| python-flask-starter | This Python/Flask boilerplate will allow to start using the Miro REST API in a few minutes. This sample implements the full Miro authorization (OAuth 2.0 with refresh token) flow. |
| python-external-oauth | This Python/Flask app shows you how to set up an OAuth 2.0 flow with GitHub. This sample allows you to log in with GitHub and post some details to a Miro Board. |
| enterprise-team-management | This Node.js sample demonstrates how to manage teams and organizations within Miro using Miro's REST API. ℹ️ This example requires an Enterprise plan subscription and an Enterprise Team account. |
| App Example | Description |
|---|---|
| monetization-with-stripe | This full-stack example shows how use Stripe to add a paywall for certain features in your app. |
| html-preview | Use the Miro API to generate HTML pages from Miro boards. Each frame on the board produces an HTML page. |
| github-appcards | This full-stack example shows how to build an integration with GitHub that syncs data between GitHub issues and Miro app cards. |
| plant-uml | This full-stack example shows how to import Plant UML diagrams into Miro as editable board items. |
| nextjs | This full-stack example shows a Next.js application that uploads a camera image to the Miro board using Web SDK and REST API integration. |
| webhooks-manager | This full-stack example demonstrates how to interact with the webhooks API, and how to handle the webhooks challenge. |
Mirotone is a CSS library that enables everyone to design and build their Miro apps. The goal of this design system is to enable makers to quickly jump into a simple, yet consistent and efficient user experience while creating their functional solutions. The framework aims to provide ready-to-use frontend components that you can incorporate into your app in Miro.
- Stuck somewhere? Encountered any blockers or errors? Need assistance? We're here to help you! Ask your question on our developer community forum.
- Feel free to open an
issueor apull requestto improve this guide. - Join our Developer community on Discord to exchange ideas and to chat with other Miro developers.