https://github.com/rcasto/peer-ftp

A tool to share files between peers, simply, and quickly.
https://github.com/rcasto/peer-ftp

data-channel p2p peer-to-peer webrtc

Last synced: about 1 month ago
JSON representation

A tool to share files between peers, simply, and quickly.

• Host: GitHub
• URL: https://github.com/rcasto/peer-ftp
• Owner: rcasto
• License: mit
• Created: 2021-07-07T03:45:09.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-07T03:52:25.000Z (over 3 years ago)
• Last Synced: 2024-10-31T21:06:50.333Z (about 2 months ago)
• Topics: data-channel, p2p, peer-to-peer, webrtc
• Language: TypeScript
• Homepage:
• Size: 28.7 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# peer-ftp

A tool to share files between peers, simply, and quickly.

## Usage

Sender needs to choose what file to send.  

Receiver needs to choose where to store the file being received.

### Flow

1. Sender initiates send of file with `peer-ftp` passing in input file path.

2. Senders uses external channel to pass generated one time code to receiver.

3. Receiver starts `peer-ftp` passing in output file path.

4. Receiver enters one time code given by sender.

5. Receiver uses external channel to pass one time code to sender.

6. Sender enters one time code given by receiver.

7. Sender and receiver should now be connected and file should start transferring.

**Note:** External channel refers to any means of communication between sender and receiver. Could be email, SMS, carrier pigeon, telepathy, Slack, phone call, ...

### Sender

```

npx peer-ftp -i 

```

### Receiver

```

npx peer-ftp -o 

```

## Potential Improvements/Continual Work

- Send/Receive more than 1 file

- Allow passing in custom STUN/TURN servers

- Browser based compatible lib/client