offloader

command module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

README

Breeji Offloader

An all-in-one solution for offloading files from (almost) any mobile device directly to your computer over wifi.

Features

Cross platform

Breeji Offloader is available for Windows, Linux and macOS.
It does not require a mobile app, so Android and iOS users can immediately start using it by navigating to the URL generated by running the app on your computer.
🖥 Standalone static binary serving full web app & server backend, no need to install any software on your computer.
📱 No need to install any software or apps on your mobile device.
✂️ Cut the cords, no need to connect your mobile device to your computer with a cable.
🔒 Runs on your local network without sending your files to other servers over the internet.

choose status


How to use

  1. Download the latest release from the releases page.
  2. Run the executable.
  3. Grab your mobile device and point it at the generated QR code, this takes you to the self-hosted web app.
    1. You must be on the same network as the computer running the app.
  4. Click anywhere in the box or drag and drop your files to upload them to your computer.
    1. Files will automatically start uploading to your computer in a directory called mobile that can be found in the same directory where the binary was run from.
    2. Files are automatically numbered by order of upload. If you close the app and reopen it, the numbering will continue from the latest file uploaded. Any extension should be accepted & preserved, but the name will be auto-generated for all files.

How to build

  1. Install Go.
  2. Run go get github.com/breeji/offloader.
  3. Run make build [platform] where platform is one of windows, linux, darwin or all.
  4. The executable will be in the build directory.

How to contribute

  • Open an issue so that it can be tied to a pull request.
  • Ensure that make lint passes with no errors or warnings.
  • Ensure that make test passes with no errors or warnings.
  • Get at least one approval from a maintainer before merging.

What could I use this for?

Quickly transfer files from your mobile device(s) to your computer regardless of the platform you're on:

  • You own a Windows/Linux PC and iPhone, and you want to transfer files from your iPhone to your PC, easily.
  • You own a Mac and Android/Other type of phone, and you want to transfer files from your phone to your Mac.
  • You are hosting an event and you want to quickly transfer photos from your guests' phones to your computer:
    • Print out the generated QR Code and slap it on the wall, tell guests to upload event photos directly to you (if they connected to your network).
  • You can't convince your friends to install a file sharing app, but you can convince them to open a web page.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
web

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL