Skip to content

socketry/live

Repository files navigation

Live

Provides bi-directional live HTML views using WebSockets for communication. You can try out a live example

Development Status

Features

  • Transparent support for both static initial rendering and dynamic updates.
  • Bi-directional event handling for seamless client/server implementation.
  • Event-driven architecture for efficient handling of thousands of active connections.

Usage

Please see the project documentation for more details.

  • Getting Started - This guide explains how to use live to render dynamic content in real-time.

  • Rails Integration - This guide explains how to use the live gem with Ruby on Rails.

Contributing

We welcome contributions to this project.

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create new Pull Request.

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

See Also

  • live-js – The client-side JavaScript library.
  • morphdom – Efficiently update the client-side HTML.
  • stimulus-reflex — An alternative framework which provides similar functionality.

Examples

  • Flappy Bird – A clone of the classic Flappy Bird game.