Skip to content

A high-performance lightweight websocket server for storing and viewing primitive values and synchronizing between clients.

License

Notifications You must be signed in to change notification settings

socketboard/socketboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Socketboard Server

A Rust-based server application designed for debugging and managing remote projects by allowing clients to view and edit variables in real-time. This system supports multiple clients with customizable permissions, making it ideal for development and monitoring purposes.


Features

  • Real-time Variable Management: View, modify, and monitor variables from a central dashboard.

  • Multi-language Client Support: Interfaces available (soon) for Python, Rust, JavaScript, and Java.

  • Permissions System (coming soon): Define client permissions for read-only, read/write, and restricted variable access.

  • Web Dashboard (coming soon): A simple and customizable UI for monitoring and editing variables.


Getting Started

Prerequisites

  • Rust (for building the server)
  • Web browser (for accessing the dashboard)
  • Supported language tools for clients (Python, Node.js, Java, etc.)

Installation

You can either download the pre-built binaries or build the server from source.

  1. Download Binaries:

    • Download the latest release from the Releases page.
    • Extract the contents to a directory of your choice.
    • Run the server executable for your platform.
      • In the future, the executable may be run with arguments to specify the host and port, as well as inital state files.
  2. Build from Source:

    • Clone the repository: git clone https://github.com/socketboard/socketboard.git
    • Navigate to the project directory: cd socketboard
    • Build the server: cargo build --release
    • Run the server: ./target/release/socketboard

Usage

  1. Start the Server:
    • Run the server executable.
    • By default, the server will start on localhost:8080.

Roadmap

  • Implement basic server functionality.

High Priority

  • Complete Rust and Python SDKs.
  • Executable arguments for customization.
  • Server password/authentication support.
  • Configuration file support.
  • Basic dashboard for variable monitoring.
  • Add persistent storage for variables.

Low Priority

  • Expand support for additional programming languages.
    • Java and JavaScript SDKs.
  • Improve dashboard with advanced visualization tools.
  • Add secure WebSocket connections (TLS/SSL).

About

A high-performance lightweight websocket server for storing and viewing primitive values and synchronizing between clients.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages