https://github.com/pablolec/sb_websocket_rust
WebSocket TUI chat server and client in Rust
https://github.com/pablolec/sb_websocket_rust
console console-application cui ratatui ratatui-rs rust rust-lang tui tui-rs websocket websocket-chat websocket-client websocket-server websockets
Last synced: 7 months ago
JSON representation
WebSocket TUI chat server and client in Rust
- Host: GitHub
- URL: https://github.com/pablolec/sb_websocket_rust
- Owner: PabloLec
- Created: 2023-12-12T17:30:00.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-23T16:28:36.000Z (almost 2 years ago)
- Last Synced: 2025-01-14T05:11:35.354Z (9 months ago)
- Topics: console, console-application, cui, ratatui, ratatui-rs, rust, rust-lang, tui, tui-rs, websocket, websocket-chat, websocket-client, websocket-server, websockets
- Language: Rust
- Homepage:
- Size: 75.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sb_websocket_rust
## Overview
This project is a console-based chat interface that relies on WebSocket communication.
One instance acts as a server if no existing server is found, while the other takes on the role of a client.
The UI is created using [Ratatui](https://github.com/ratatui-org/ratatui).
## Demo
## Instructions to Run
- Run two separate instances of the application using:
```
docker run -it --network host pablolec/sb_websocket_rust:latest
```
- Once both instances are up and connected, type your message, press Enter to send, and Esc to exit the application.
## Enhancements
- The WebSocket implementation currently uses only the standard library and thus covers only a small part of [RFC 6455](https://tools.ietf.org/html/rfc6455). For example, there is currently no solution to gracefully shut down the connection.
- The application currently operates intentionally only on localhost. An area for improvement would be to display an initial screen with the option to select the host and port to connect to.
- The UI can obviously be improved, for instance, by adding metadata (users, timestamps of messages) or by offering the possibility to scroll through messages.