Skip to content

Lets you build real-time applications without managing WebSocket infrastructure.

Notifications You must be signed in to change notification settings

toffee-k21/velyx-docs

Repository files navigation

Velyx Logo

Velyx Docs

Official documentation repository for Velyx — a developer-first real-time infrastructure platform.

What is Velyx?

Velyx is a real-time event delivery layer designed for modern applications.

It allows you to:

  • Publish events from your backend
  • Deliver them instantly to connected clients
  • Manage real-time connections without handling scaling, reconnections, or routing logic

Velyx focuses on simplicity, reliability, and developer experience.

About This Repository

This repository exists to:

  • Maintain clear and accurate documentation for Velyx
  • Improve developer experience through good explanations and examples
  • Allow the community to contribute to docs in an open way

If you’re looking for the Velyx source code, this repository focuses only on documentation.

Tech Stack

The documentation site is built using:

  • Next.js — documentation framework
  • TypeScript — type safety
  • NextAuth.js — authentication (Google OAuth)
  • JWT — backend authentication tokens
  • Tailwind CSS — styling

Architecture Overview

Below is a high-level, conceptual overview of how Velyx works.

This diagram focuses on data flow, not internal implementation details.

image

How Velyx Works (Conceptual)

  1. Clients connect to Velyx using WebSockets
  2. Clients subscribe to topics
  3. Backend services publish events via HTTP
  4. Velyx delivers events to all active subscribers in real time

This separation keeps application backends stateless and scalable.

About

Lets you build real-time applications without managing WebSocket infrastructure.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages