Code Monkey home page Code Monkey logo

pc-companion's Introduction

Logo

PC Companion

What is PC Companion?

PC Companion is program that allows you to control your PC (Windows, Mac, Linux) via a local webapp.

Logo

Why?

I like to game on my PC using a controller in a comfy recliner and have had issues with wireless keyboards. There are many remote PC controller apps out there but many paywall certain mouse/keyboard interactions and are closed source (who knows what they are recording...). This application runs entirely on your local network and the code you clone is the code that's run.

How to use

Requirements

Bun= v1.1.7

Clone, Build, Run

  1. git clone https://github.com/ZachJW34/pc-companion.git && cd pc-companion

  2. bun install

  3. bun run build

  4. bun run start

A local server is now running, visit the url printed in the terminal output and control your PC remotely!

Development

bun run dev

This will spawn two processes, the bun server that listens to WebSocket messages and the frontend server (Vue + Vite).

The Vite server can be accessed from any device on your local network by visiting http://<ip-address-of-machine-running-server>:<port>.

Contributions Welcome!!!

If you find any issues, feel free to post an issue. If you want to contribute, fork the repo and open a pull request.

pc-companion's People

Contributors

zachjw34 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.