Skip to content

Quick start ​

From an empty file to your app in a real ReMeet meeting in about five minutes.

1. Write the page ​

A ReMeet app is a normal web page. This one greets the person and lets everyone in the meeting wave to each other:

html
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Wave</title>
</head>
<body>
  <h1 id="hello">Connecting…</h1>
  <button id="wave">👋 Wave to everyone</button>

  <script src="https://sdk.remeet.video/v0.js"></script>
  <script>
    ReMeet.ready().then((app) => {
      document.getElementById('hello').textContent = `Hello, ${app.me.name}!`;

      document.getElementById('wave').onclick = () => app.broadcast({ type: 'wave' });

      app.on('broadcast', ({ from, data }) => {
        if (data.type === 'wave') {
          app.notify(`${from.name} waves`);
          app.badges.set(from.id, '👋');
        }
      });
    }).catch((error) => {
      document.getElementById('hello').textContent = error.message;
    });
  </script>
</body>
</html>

Start from the template

starter.html is one file that uses the whole API: participants, broadcast, storage, badges and toasts. You can give it to any AI tool as a base: «make me a ReMeet app that…».

2. Put it on https ​

Any static hosting works: GitHub Pages, Netlify, Vercel, Cloudflare Pages or your own server. The rules:

  • the address is https;
  • it is your domain, not remeet.video;
  • the page can be shown in a frame on https://remeet.video: it does not send X-Frame-Options: DENY and its Content-Security-Policy frame-ancestors, if you set one, includes https://remeet.video and https://sdk.remeet.video. Most static hosts allow framing by default.

3. Try it in the simulator ​

Open the simulator with your page address:

https://sdk.remeet.video/simulator.html?url=https://your-site.example/wave.html

It runs two copies of your app — You and Anna — as if you were two people in one meeting. Press «Wave» in one, and the other gets the message. More in Simulator.

4. Describe the app in remeet.json ​

Put the manifest next to the page, on any https address:

json
{
  "key": "wave",
  "version": "0.1.0",
  "name": { "en": "Wave", "ru": "Помахать" },
  "description": { "en": "Wave to everyone in the meeting." },
  "developer": { "name": "Your name", "url": "https://your-site.example" },
  "surfaces": {
    "panel": { "url": "https://your-site.example/wave.html" }
  },
  "permissions": ["app.broadcast", "badges.write"]
}

Every field is described in Manifest. Ask only for the permissions you use: people see the list before they install.

5. Add it to ReMeet ​

During the closed beta, the ReMeet team adds apps by their manifest address: Admin → Marketplace → Add an app by manifest. ReMeet checks the manifest and the app appears in the marketplace marked Beta. Send the manifest address to the ReMeet team.

Coming next

Developer accounts: you apply, we approve, and then you add your apps yourself, test them privately and submit them to the marketplace.

6. Install it and open it in a meeting ​

  1. Marketplace → your app → Allow and add. The window lists what the app will be able to do.
  2. Start or join a meeting → More → your app. It opens in the side panel.
  3. Join the same meeting from a second device with another account that also has the app installed, and wave.

That's it. Next: how it works.

ReMeet Apps SDK v0 · beta. The SDK file v0.js is MIT.