# Miro to Neoboard Converter

This tool converts Miro boards to a format that can be imported into the Matrix Neoboard whiteboard developed by Nordeck.

## Overview

The Miro to Neoboard Converter is designed to help users seamlessly transition their Miro boards into the Neoboard format. This is particularly useful for teams and organizations that use both Miro and Neoboard for their collaborative whiteboarding needs.

**Note:** This tool is highly experimental and requires a Miro app for proper functionality.

## Features

- Convert single or multiple Miro boards to Neoboard format.
- Preserve shapes, text, and other elements during the conversion.
- Ensure compatibility with the Neoboard whiteboard developed by Nordeck.

## Limitations

- The converter may not support all Miro elements or features.
- It only works for frames. It does not export the entire board.

## Prerequisites

- Node.js installed on your machine.
- A Miro app with the necessary credentials.

## Installation

1. Clone the repository:

```sh
git clone https://git.midnightthoughts.space/neoboard-miro-converter
cd neoboard-exporter
```

2. Install the dependencies:

```sh
pnpm install
# Miro api package is partially broken so we patch it
patch -p1 < miro_api_styles_fix.patch
```

## Usage

### Adding an .env file

Create a `.env` file in the root of the project with the following content:

```environment
MIRO_CLIENT_ID="<your miro client id>"
MIRO_CLIENT_SECRET="<your miro client secret>"
MIRO_REDIRECT_URL="http://localhost:3000/api/redirect"
```

If you are publicly hosting this, you should change the `MIRO_REDIRECT_URL` to the URL of your server.

### Running the Converter

1. Build the project:

```sh
pnpm run build
```

2. Start the development server:

```sh
pnpm run start
```

3. Open your browser and navigate to `http://localhost:3000` to use the converter.

## Contributing

We welcome contributions! Please read our [contributing guidelines](CONTRIBUTING.md) for more details.

## Issue Tracker

We use an mailing list for tracking issues and feature requests. Please send an email to
`neoboard-miro-converter@lists.midnightthoughts.space` with the subject line
starting with `[Issue]` or `[Feature]` followed by a brief description.
Additionally there is an archive of the mailing list at
<https://lists.midnightthoughts.space/archives/list/neoboard-miro-converter@lists.midnightthoughts.space/>.