wordle

Miro Wordle App

This app shows you how to build Wordle on a Miro board by creating sticky notes with the relevant colors.

👨🏻‍💻 App Demo

wordle-app-demo.mov

📒 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
  • miro.board.createStickyNote()
  • miro.board.getById()
  • remove()
  • miro.board.viewport.get()
  • miro.board.ui.openPanel()

🛠️ 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.

🏃🏽‍♂️ 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 and then click save:

# See https://developers.miro.com/docs/app-manifest on how to use this
appName: Wordle
sdkVersion: SDK_V2
sdkUri: http://localhost:3000
scopes:
  - 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 Wordle 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
│  └── styles
│      └── style.css <-- CSS styles for the app.
│  └── App.tsx <-- The main app. Contains structure for the sidebar when launched.
│      main.tsx <-- Initializes the git app.
│      └── lib
│         └── board.ts <-- Methods to create and update content on Miro's board.
│         └── word.ts <-- Methods to select word for the game and
check game statuses.
│      └── constants
│         └── validGuesses.ts <-- List of words that can be guesses in the game.
│         └── wordList.ts <-- List of words to pick from in the game.
├── app.html <-- The app itself. This is loaded on the board inside the 'appContainer'.
└── 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.