https://github.com/robmcelhinney/qr-file-share

Node.js http server allowing for file transfers over local area network with QR code.
https://github.com/robmcelhinney/qr-file-share

docker express file-share http-server nodejs qrcode react

Last synced: 2 months ago
JSON representation

Node.js http server allowing for file transfers over local area network with QR code.

• Host: GitHub
• URL: https://github.com/robmcelhinney/qr-file-share
• Owner: robmcelhinney
• License: lgpl-3.0
• Created: 2020-05-05T20:51:27.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-19T05:13:06.000Z (7 months ago)
• Last Synced: 2024-11-01T22:50:27.620Z (2 months ago)
• Topics: docker, express, file-share, http-server, nodejs, qrcode, react
• Language: JavaScript
• Homepage:
• Size: 12.2 MB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# qr-file-share

Node.js http server allowing for file transfers over local area network made easier with QR code output on start.

## Download application

[https://github.com/robmcelhinney/qr-file-share/releases](https://github.com/robmcelhinney/qr-file-share/releases)

## Install

Install from repo:

    $ git clone [email protected]:robmcelhinney/qr-file-share.git

    $ cd qr-file-share

    $ npm install

Install with npm/Node.js:

    $ npm i @robmcelhinney/qr-file-share -g

## Usage

Must be on same WiFi.

    $ cd /dir/to/share

    $ qr-file-share

Manual

	$ node bin

Call other path

	$ node bin --path=/path/to/share

## Demo

![screenshot of program running from command line](demo/screenshot.png)

![screenshot of web interface on mobile](demo/mobile_screenshot.png)

![Phone using camera to detect qr code](demo/sample.gif)

## Start & watch

    $ npm start

Open [http://localhost:8080](http://localhost:8080) to view it in the browser.

Also provides the local ip address and a qr code to view on another device on same network.

## Help

    $ qr-file-share --help

or

    $ node bin.js --help

## DOCKER

Does this need docker? Who knows? Probably not but I want to learn Docker.

The QR code links to the container's ip so it doesn't work over the local network but should work on the device running the container.

Build

	$ docker build -t qr-file-share .

Run

	$ docker run -dp 8080:8080 --name qr-file-share --mount type=bind,source=/path/to/share,target=/target qr-file-share --path=/target

## Built With

* QR Code: https://github.com/gtanner/qrcode-terminal

* Archiver: https://github.com/archiverjs/node-archiver

* Meow (CLI helper): https://www.npmjs.com/package/meow

## Inspiration

* https://github.com/mifi/ezshare