https://github.com/landakram/serenity

P2P file transfer in the browser using WebRTC.
https://github.com/landakram/serenity

Last synced: 5 months ago
JSON representation

P2P file transfer in the browser using WebRTC.

• Host: GitHub
• URL: https://github.com/landakram/serenity
• Owner: landakram
• License: mit
• Created: 2020-04-18T16:14:20.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-03-26T14:36:04.000Z (about 3 years ago)
• Last Synced: 2024-04-14T20:15:18.547Z (about 1 year ago)
• Language: Clojure
• Homepage: https://serenity.markhudnall.com
• Size: 40.3 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SERENITY

> P2P file transfer over WebRTC.

Serenity is peer-to-peer file transfer in the browser. Using [WebRTC](https://webrtc.org/), two browsers are directly connected, allowing 

private, encrypted file transfer without an intermediary.

Serenity is available at [serenity.markhudnall.com](https://serenity.markhudnall.com).

![](doc/serenity.gif)

## Usage

When you visit Serenity, you'll be connected to a [signaling server](https://www.html5rocks.com/en/tutorials/webrtc/infrastructure/#what-is-signaling) 

and receive a peer link. Send this peer link to a friend. When they visit the link, you'll be connected to each other over WebRTC. Once you're 

connected, you can drag and drop files into the browser window to share them.

Serenity supports arbitrary file sizes and avoids buffering them in memory by using [StreamSaver](https://github.com/jimmywarting/StreamSaver.js). 

In practice, I've used Serenity to transfer files up to 4gb.

A number of other commands are also available by typing `help` into the browser window. For example, you can print the status of the WebRTC 

connection by typing `status`.