Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 1.68 KB

README.md

File metadata and controls

54 lines (32 loc) · 1.68 KB
Raw

CI License: MIT

Rust Knight

RustKnight is a modern, open-source chess game that brings the classic game to your fingertips, developed using the Rust programming language. With its backend powered by Rocket and SurrealDB, RustKnight offers a seamless and responsive gaming experience. The project is divided into a web app, crafted with Yew for a rich interactive experience, and a desktop app built with Tauri, ensuring a lightweight and efficient application.

Features

  • Play Chess Online: Engage in chess games with players around the world.
  • Cross-Platform Support: Available as both a web and a desktop application.
  • Modern UI: A clean, intuitive interface for easy navigation and gameplay.
  • Real-Time Updates: Live updates of game moves and real-time chat.
  • Secure and Reliable: Built on the robust Rust ecosystem, ensuring safety and performance.

Getting Started

Prerequisites

  • Rust (latest stable version)
  • Cargo
  • Node.js and npm (for web app development)

Installation

Clone the repository:

git clone https://github.com/yourusername/RustKnight.git
cd rust-knight

Backend setup

Navigate to the backend directory and run:

Work in progress

Web app setup

Navigate to the web app directory and run:

Work in progress

Desktop app setup

Navigate to the desktop app directory and run:

Work in progress

LICENSE

Distributed under the MIT License. See LICENSE for more information.