Getting Started

Set up Your Account

You will need a Convergence Account in order to get started. If you don’t already have one, request one here.

Convergence provides high-level APIs for building realtime collaborative applications. Thus, we treat your application’s users as first-class citizens. Any collaborative app needs users, and the easiest way to add users is through the Convergence Administration Console 1.

Log into your account. On the home page you will see a few cards representing domains2. Click the ‘Users’ button on the Examples domain card, and then the plus icon at right. Fill in a username, display name and simple password, and click “Create”. This will be the “end user” that your application will connect as.

Get the Code

To get the code, clone (or fork) the Getting Started Repository from GitHub:

Then, configure the application to connect to your domain using the user you just created. Copy config.example.js to config.js and edit the three variables. You should have the username and password of the new user, and you can get the connection URL from the Admin console. Just click on the Dashboard link in the sidebar of the Examples domain and copy the Connection URL.


Simply open index.html in your web browser to run the application. Open it a second time in another web browser and type in the textarea to see your changes propagated in real time!
Want more? Check out the examples repository in GitHub demonstrating activities, chat, and more.
  1. We often talk about two different types of users: Administration and Domain Users. When you signed up for Convergence, we created an Admin User for you, which allows you to sign into the Administration Console and manage your account and domains. But when developing, you will be working within a single domain, which has its own set of users. These represent users of the application that you will build. In this guide, we will create users manually, but they can also be created automatically using JWTs.
  2. Domains are organizational entities: you can think of them as projects, different environments (such as Prod or Staging), or some combination of both. Domains are self-encapsulated, configurable, and contain their own data and users. See here for more information.