diff --git a/README.md b/README.md index 3dba163..d601346 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,30 @@ -# teleport +# Teleport +Teleport is a native GTK3 app to effortlessly share files on the local network. +![Teleport Mockup](docs/mvp-mockup.png) -###Build +It's our answer to the question +> Why is the easiest way to move a file between two computers in the same room sending it to a server in another country and retrieving it from there? +Teleport is designed to be a replacement for using USB keys or emailing stuff to yourself just so you have them on another device on your desk. The main user interface on the receiver's side are notifications: + +![Teleport Notifications Mockup](docs/notifications.png) + +## Roadmap +We are currently working on an MVP for a native GNOME app that only sends files, but longer term we are interested in doing things like: +* drag & drop files to send them +* sending text snippets +* file transfer progress bars +* settings dialog +* file encryption +* native Android/iOS/macOS/Windows apps + +## Build ``` cd src make ``` + +## License +AGPLv3, because freeeeeeedom diff --git a/docs/flow-diagram.png b/docs/flow-diagram.png new file mode 100644 index 0000000..17f5525 Binary files /dev/null and b/docs/flow-diagram.png differ diff --git a/docs/flow-diagram.svg b/docs/flow-diagram.svg new file mode 100644 index 0000000..6e3df50 --- /dev/null +++ b/docs/flow-diagram.svg @@ -0,0 +1,1266 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + Jan's Librem + Angela's Thinkpad + Jan sends path/file.png + Add route 192.168.1.156:4000/transfer/file.png + Create random token "X0fg356" + to 192.168.1.34:3401 + + POST + Send file transfer request + Show notification + + + + Teleport + + + + + + + + + + + + + + Jan's Librem is sending file.png (123kB) + + Save + Decline + + + Nothing happens + + Request ip:port/file.png + + GET + + Check if token matches + Send file in response to GET request + Send error response to GET request + + + + RESPONSE + file.png + Store file.png in ~/Downloads + Show notification + + + + Teleport + + + + + + + + + + + + + + Transfer of file.png from Jan's Librem is complete + Open + + Send file + + + Jan's Librem + Angela's Thinkpad + Jan opens app or enables discovery + Create new Avahi service + Setup & Discovery + 192.168.1.156:4000/transfer/file.pngtoken in HTTP header + service type: _http._tcpservice name: jan@teleportport: 4000ip: 192.168.1.156 + + FILE ACCESSIBLE + + DISCOVERABLE + Already connected + DISCOVERABLE + + angela@teleport + jan@teleport + Periodically by Avahi: + Scan local network for Teleport devices + + angela@teleport + Display newly discovered devices + + angela + + Send File + service type: _http._tcpservice name: angela@teleportport: 3401ip: 192.168.1.34 + If no requests are made within 1 min, remove route to file.png + { token: "X0fg356", size: 123404, (byte) name: "file.png"} + + Open HTTP server on 192.168.1.156:4000 + + ACCEPT REQUESTS + + DISCOVERS + + diff --git a/docs/mvp b/docs/mvp new file mode 100644 index 0000000..bdc0970 --- /dev/null +++ b/docs/mvp @@ -0,0 +1,17 @@ +scope for mvp + +features +- turn daemon on and off in headerbar +- click "send file" and select file in file chooser to send file +- notification on receiver side to confirm +- notification on receiver side when transfer is complete + +- avahi service publishing and discovery +- open and close http server +- download from url + + +not in scope +- popovers for settings and name +- displaying files in ui +- drag and drop to send diff --git a/docs/mvp-mockup.png b/docs/mvp-mockup.png new file mode 100644 index 0000000..bd8825a Binary files /dev/null and b/docs/mvp-mockup.png differ diff --git a/docs/mvp.svg b/docs/mvp.svg new file mode 100644 index 0000000..3fac6c8 --- /dev/null +++ b/docs/mvp.svg @@ -0,0 +1,798 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + This device + + Angela's Thinkpad + + + + + + + + + + + + + + + Kim's Zenbook + + Send File + Other devices on o2-WLAN09 + + Jan's Librem + + Send File + + + + + + + Visible on network + + + Teleport + + + + + + + + + + + + + + Transfer of setup.sh from Jan's Librem is complete + Open + Drag and drop files on devices to send them + Teleport + + + Teleport + + + + + + + + + + + + + + Jan's Librem is sending setup.sh (330kB) + + Save + Decline + + + + This device + + Angela's Thinkpad + + + + + + + + + + + + + + + + + + + + + + + Visible on network + Teleport + + Other devices on o2-WLAN09 + + To start sharing files, your device has tobe visible to others on o2-WLAN09 + + + Make me visible + + + + diff --git a/docs/notifications.png b/docs/notifications.png new file mode 100644 index 0000000..464fd86 Binary files /dev/null and b/docs/notifications.png differ