Skip to content

Quickstart

Create your first room

After creating an account, head to the rooms page and click "Create Room". Select "Public" so anyone can join without authenticating. You can then press the button to enter the room. Leave the auth key field blank to enter anonymously. Congratulations, you have now entered your first EZChat chat room!

Create your first user

To create a user, head to the users page and click "Create User". Give that user a username and press "Create User". You can then press the icon to generate an auth key you can use for 15 minutes to enter chat rooms. Ideally you should only be using this for debugging, on a server you should be creating these keys using the libraries.

Connecting to your room from the browser

After creating a room, you can test out connecting to a room from the browser by installing the react library

yarn add @ezchat/react
# or
pnpm add @ezchat/react

and then connecting to your room like this:

import { useEzChatRoomConnection } from "@ezchat/frontend/react";
const ezchat = useEzChatRoomConnection(<roomId>);

Its as simple as that! You can then use the ezchat object to send messages, see the current chat log, and more. Check out the react library for more information.

Frontend Libraries

Server Libraries