Skip to content

README.md

Latest commit

 

History

History
95 lines (65 loc) · 2.58 KB

README.md

File metadata and controls

95 lines (65 loc) · 2.58 KB

RustDesk Web Client

Features

  • Remote Desktop Access: Connect to RustDesk client from the web.
  • Remote Camera Access: View remote camera/desktop from the web.
  • File Transfers: Support for trzsz/ZMODEM file transfers.
  • Terminal Interface: Built with Xterm.js for a powerful and feature-rich terminal experience.
  • Modern Tech Stack: Utilizes React, Vite, and TypeScript for a fast and reliable development experience.
  • Deployable on the Edge: Designed to be deployed to Cloudflare Workers.
  • Built-in rustdesk server: rustdesk hbbs with websocket relay supported.

Ideas

  • Dockerfile for local deploy
  • ssh from web
  • keyboard mouse control
  • more handy cli utils

Getting Started

Follow these instructions to get a local copy up and running for development and testing purposes.

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/lichon/rustdesk-web-ts.git
cd rustdesk-web-ts

  2. Install the dependencies:

    pnpm install

Development

To run the application in development mode:

pnpm dev

This will start a local development server, typically at http://localhost:80.

Building

To create a production build of the application:

pnpm build

The build artifacts will be stored in the dist/ directory.

Deployment

This project is configured for deployment to Cloudflare Workers.

To deploy the application, run:

pnpm deploy

This will build the project and deploy it using the Wrangler CLI.

Available Scripts

  • pnpm dev: Runs the app in development mode.
  • pnpm build: Builds the app for production.
  • pnpm lint: Lints the source code using ESLint.
  • pnpm preview: Serves the production build locally for preview.
  • pnpm deploy: Deploys the application to Cloudflare Workers.
  • pnpm cf-typegen: Generates types for Cloudflare Workers.

Technologies Used