Skip to content

adidharmatoru/remo

Repository files navigation

Remo - Hardware-Accelerated Remote Desktop

CICD codecov Docker Pulls

Remo is a hardware-accelerated remote desktop solution built with Rust and Nuxt 3. This repository contains the front-end application that provides a seamless user interface.

Demo

Repository: The demo repository is available here

Download: Download directly from public demo - latest release

Getting Started

To get started, follow these steps:

Prerequisites

  1. Install Node.js and npm (the package manager) on your system.
  2. Create a new directory for your project and navigate to it in your terminal or command prompt.

Installation

Run the following command to install the dependencies:

npm install

This will install all the necessary dependencies, including Nuxt 3, Vue.js, and other libraries required for the project.

Development Server

To start the development server, run the following command:

npm run dev

This will start the server on http://localhost:3000, where you can access Remo.

Docker Compose

You can also run Remo using Docker Compose:

docker-compose up -d

This will build and start the container in detached mode. The application will be available at http://localhost.

Contributing

We welcome contributions to Remo! If you'd like to contribute, please follow these steps:

  1. Fork this repository and make your changes.
  2. Open a pull request with your changes.

We'll review your changes and let you know if they're accepted.

License

Remo is licensed under the MIT License. If you have any questions about the license, please don't hesitate to reach out.