ContextQMD
Back to Realtime

README

README.md

2.90.14.2 KB
Original Source
<p align="center"> <a href="https://supabase.io"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg"> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg"> 
</picture>
</a> <h1 align="center">Supabase Realtime</h1> <p align="center"> Send ephemeral messages, track and synchronize shared state, and listen to Postgres changes all over WebSockets. 
<a href="https://supabase.com/docs/guides/realtime#examples">Examples</a>
·
<a href="https://github.com/orgs/supabase/discussions/new?category=feature-requests">Request Features</a>
·
<a href="https://github.com/supabase/realtime/issues/new?assignees=&labels=bug&template=1.Bug_report.md">Report Bugs</a>
</p> </p>

Status

Featuresv1v2Status
Postgres Changes✔✔GA
Broadcast✔GA
Presence✔GA

This repository focuses on version 2 but you can still access the previous version's code and Docker image. For the latest Docker images go to https://hub.docker.com/r/supabase/realtime.

The codebase is under heavy development and the documentation is constantly evolving. Give it a try and let us know what you think by creating an issue. Watch releases of this repo to get notified of updates. And give us a star if you like it!

Overview

What is this?

This is a server built with Elixir using the Phoenix Framework that enables the following functionality:

  • Broadcast: Send ephemeral messages from client to clients with low latency.
  • Presence: Track and synchronize shared state between clients.
  • Postgres Changes: Listen to Postgres database changes and send them to authorized clients.

For a more detailed overview head over to Realtime guides.

Does this server guarantee message delivery?

The server does not guarantee that every message will be delivered to your clients so keep that in mind as you're using Realtime.

Quick start

You can check out the Supabase UI Library Realtime components and the repository of the multiplayer.dev demo app.

Developers

Start with DEVELOPERS.md for local setup, mise tasks, and example workflows.

Once your environment is up and running, check out the following docs to customize the server and troubleshooting:

Contributing

See CONTRIBUTING.md

Code of Conduct

See supabase/CODE_OF_CONDUCT.md

License

This repo is licensed under Apache 2.0.

Credits