Skip to main content

Introduction

What is Realtimely?#

Realtimely makes it easy to introduce fun real-time elements into your React app. Realtimely uses GraphQL and communicates with the cloud by websocket, but users don't have to be aware of it, and just can implement a websocket-based real-time experience simply by using the hooks function provided by Realtimely.

For Example#

demo

The simplest and most straightforward feature is the "Realtime Cursor". Simply create the following components using the useRealtimeCursor provided by Realtimely, and you will be able to share the movement of the mouse cursor of everyone who uses your web application in real time.

import { useRealtimeCursor } from 'realtimely';
export default () => {    const { onMouseMove, renderCursors } = useRealtimeCursor()    return (        <div onMouseMove={onMouseMove}>                {renderCursors()}        </div>    )}

What you can do#

Realtimely also provides a function called useRealtimeUserAction that is easier to use and has a wider range of usecase. See the simple code below.

import { useRealtimeUserAction } from 'realtimely';
export default () => {    const { pushUserAction, userActionList } = useRealtimeUserAction()    return (<>        <button onClick={() => {pushUserAction("actionId","value")}}>click</button>        {JSON.stringify(userActionList)}    </>)}

Calling the useRealtimeUserAction function will start monitoring user actions. If you execute some value as an argument with the pushUserAction method, that value will be delivered to the userActionList of all users viewing the same URL.

With just this function, you can implement various features such as chat system and user presence. Please try to create interesting features that will make your site more lively.