PairDrop/README.md

60 lines
2.5 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-17 10:50:28 +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-18 15:45:53 +01:00
[//]: # (Todo: add File Handler API Doku)
### Other changes
* 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))
* [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))
## Screenshot
![test](/docs/pairdrop_screenshot_desktop.png)
2023-01-17 10:50:28 +01:00
## Snapdrop and PairDrop are 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)
2015-12-18 16:50:36 +01:00
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-17 10:50:28 +01:00
PairDrop is free and always will be!
2020-01-31 09:17:35 +01:00
2023-01-17 10:50:28 +01:00
Do you want to support me?<br>
<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
2018-09-21 16:12:21 +02:00
To support the original Snapdrop and its creator go to [his GitHub page](https://github.com/RobinLinus/snapdrop).
2020-07-14 22:30:09 +02:00
2020-01-16 09:07:37 +01:00
Thanks a lot for supporting free and open software!
## 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).