PairDrop/README.md

72 lines
3.9 KiB
Markdown
Raw Normal View History

2023-01-17 10:50:28 +01:00
# PairDrop
2015-12-18 16:50:36 +01:00
2023-01-20 16:23:02 +01:00
[PairDrop](https://pairdrop.net): local file sharing in your browser. Inspired by Apple's AirDrop.
2017-01-14 21:52:52 +01:00
Developed based on [Snapdrop](https://github.com/RobinLinus/snapdrop)
2020-09-14 02:56:12 +02:00
## Differences to Snapdrop
### Device Pairing
* Pair devices via 6-digit code or QR-Code
* Pair devices outside your local network or in complex network environment (public wifi, company network, Apple Private Relay, VPN etc.).
* Paired devices will always find each other via shared secrets even after reopening the browser or the Progressive Web App
* You will always discover devices on your local network. Paired devices are shown additionally.
* Paired devices outside your local network that are behind a NAT are connected automatically via [Open Relay: Free WebRTC TURN Server](https://www.metered.ca/tools/openrelay/)
2023-01-19 19:07:43 +01:00
### [Improved UI for sending/receiving files](https://github.com/RobinLinus/snapdrop/issues/560)
* The receiving peer must accept the request of files **before** they are transferred and downloaded automatically afterwords if possible
* Multiple files are downloaded as ZIP file
* On iOS and Android the devices share menu is opened instead of downloading the files
* Multiple files are transferred at one archive which shows the overall progress correctly
* The integrity of the files is checked on receive
* By zipping the files before sending, all metadata is preserved
### Share Files Directly From Share / Context Menu
* [Share files directly form context menu on Windows](/docs/how-to.md#share-files-directly-form-context-menu-on-windows)
* [Share directly from share menu on iOS](/docs/how-to.md#share-directly-from-share-menu-on-ios)
* [Share directly from share menu on Android](/docs/how-to.md#share-directly-from-share-menu-on-android)
### Other changes
2023-01-19 19:07:43 +01:00
* [Paste Mode](https://github.com/RobinLinus/snapdrop/pull/534)
* [Video and Audio preview](https://github.com/RobinLinus/snapdrop/pull/455) (thanks [@victorwads](https://github.com/victorwads))
* [Prevent device from sleeping on file transfer](https://github.com/RobinLinus/snapdrop/pull/413)
* node-only implementation (thanks [@Bellisario](https://github.com/Bellisario))
* automatic restart on error (thanks [@KaKi87](https://github.com/KaKi87))
* lots of stability fixes (thanks [@MWY001](https://github.com/MWY001) [@skiby7](https://github.com/skiby7) [@willstott101](https://github.com/willstott101))
2023-01-19 19:07:43 +01:00
* To host PairDrop on your local network (e.g. on Raspberry Pi): [All peers connected with private IPs are discoverable by each other](https://github.com/RobinLinus/snapdrop/pull/558)
2023-01-19 19:07:43 +01:00
## Screenshots
![Pairdrop Preview](/docs/pairdrop_screenshot_mobile.gif)
2023-01-19 19:07:43 +01:00
## PairDrop is built with the following awesome technologies:
2020-12-20 04:01:53 +01:00
* Vanilla HTML5 / ES6 / CSS3 frontend
* [WebRTC](http://webrtc.org/) / [WebSockets](http://www.websocket.org/)
* [NodeJS](https://nodejs.org/en/) backend
* [Progressive Web App](https://wikipedia.org/wiki/Progressive_Web_App)
2023-01-19 19:07:43 +01:00
* [IndexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
2023-01-19 23:57:13 +01:00
* [zip.js](https://gildas-lormeau.github.io/zip.js/)
2020-12-15 22:29:02 +01:00
2020-12-20 04:01:53 +01:00
Have any questions? Read our [FAQ](/docs/faq.md).
2020-12-15 22:29:02 +01:00
You can [host your own instance with Docker](/docs/host-your-own.md).
2020-09-14 02:56:12 +02:00
2020-12-15 22:29:02 +01:00
## Support the Community
2023-01-19 19:07:43 +01:00
PairDrop is free and always will be. Still, we have to pay for the domain.
2020-01-31 09:17:35 +01:00
2023-01-19 19:07:43 +01:00
To contribute and support me:<br>
2023-01-17 10:50:28 +01:00
<a href="https://www.buymeacoffee.com/pairdrop" target="_blank">
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" >
</a>
2020-01-31 09:17:35 +01:00
2020-01-16 09:07:37 +01:00
Thanks a lot for supporting free and open software!
2023-01-19 19:07:43 +01:00
To support the original Snapdrop and its creator go to [his GitHub page](https://github.com/RobinLinus/snapdrop).
## How to contribute
Feel free to [open an issue](https://github.com/schlagmichdoch/pairdrop/issues/new/choose) or a
[pull request](https://github.com/schlagmichdoch/pairdrop/pulls) but follow
[Contributing Guidelines](/CONTRIBUTING.md).