odonno / surrealdb-presence-demo

Demo project on how to create a realtime presence web application using SurrealDB Live Queries

SurrealDB Presence Demo

This is a demo project on how to create a realtime presence web application using SurrealDB Live Queries.

Tech stack

This is a list of the most important technologies used in this project:

• React + TypeScript (Vite template)
• TanStack Query
• jotai (jotai-forms)
• SurrealDB
• surrealdb-migrations

Features

• Authentication
  • Sign up
  • Sign in
  • Sign out
  • Display authenticated user details such as realtime presence
• List of rooms with number of active users, with the ability to join a room
• Selected room (last joined room)
  • Display the list of users in rooms
  • Show presence of each user
  • Ability to leave the room

Current configuration:

• Signal user presence in room periodically (every 10 seconds)
• Display presence status:
  • gray - left
  • green - < 2min of inactivity
  • orange - < 10min of inactivity
  • red - > 10min of inactivity

Get started

1. Start a new SurrealDB instance locally

surreal start --log debug --user root --pass root memory --auth --allow-guests

2. Apply migrations

surrealdb-migrations apply

3. Install dependencies and run the web app

npm install
npm run dev

4. Launch your web browser on the generated url (eg. http://localhost:5173/) and play with the app (create new accounts, join rooms, leave rooms)

And voilà!

Architecture

This project is using the following architecture:

• /schemas - list of SurrealDB tables
• /events - list of SurrealDB events
• /migrations - list of db migrations that will be automatically applied
• /src
  • /components
  • /pages
  • /contexts - Theme and SurrealDB providers
  • /queries - surql query files to query the database, using SurrealDB tables
  • /mutations - surql query files to create or update data, using SurrealDB events
  • /lib - functions and app models
  • /constants