README.md 1.96 KB
Newer Older
Tobias Bernard's avatar
Tobias Bernard committed
1 2
# Teleport
Teleport is a native GTK3 app to effortlessly share files on the local network.
Julian Sparber's avatar
Julian Sparber committed
3

Tobias Bernard's avatar
Tobias Bernard committed
4
![Teleport Mockup](docs/mvp-mockup.png)
Julian Sparber's avatar
Julian Sparber committed
5

Tobias Bernard's avatar
Tobias Bernard committed
6
It's our answer to the question
Julian Sparber's avatar
Julian Sparber committed
7

Tobias Bernard's avatar
Tobias Bernard committed
8
> 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?
Julian Sparber's avatar
Julian Sparber committed
9

Tobias Bernard's avatar
Tobias Bernard committed
10 11 12 13
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)

14
## Install
Tobias Bernard's avatar
Tobias Bernard committed
15
Teleport is currently in early development, but you can try it by installing it via [flatpak](http://flatpak.org). If you're running a modern GNU/Linux distro you should already have flatpak, or be able to install it from your repositories.
16 17 18 19 20 21 22 23

If you have GNOME Software (or another GUI app to install flatpaks), just [download this file](https://raw.githubusercontent.com/frac-tion/teleport-flatpak/master/teleport.flatpakref) and open it in Software (your browser should offer to do that before downloading).

Otherwise you can also install it from the command line:
```
flatpak install --from  http://frac-tion.com/teleport-flatpak/teleport.flatpakref
```

Tobias Bernard's avatar
Tobias Bernard committed
24 25 26 27 28 29 30 31 32 33
## 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
Julian Sparber's avatar
Julian Sparber committed
34
#### Archlinux
Julian Sparber's avatar
Julian Sparber committed
35
```
36
  pacman -S base-devel libsoup avahi gtk3 meson
37
  git clone https://github.com/frac-tion/teleport.git
38 39
  cd teleport
  ./configure
Julian Sparber's avatar
Julian Sparber committed
40
  make
41
  ./_build/src/teleport
Julian Sparber's avatar
Julian Sparber committed
42
```
Julian Sparber's avatar
Julian Sparber committed
43
#### Ubuntu
44
```
45
  apt install pkg-config libsoup2.4-dev libavahi-client3 libgtk-3-dev meson
46
  git clone https://github.com/frac-tion/teleport.git
47 48
  cd teleport
  ./configure
49
  make
50
  ./_build/src/teleport
51 52
```

Tobias Bernard's avatar
Tobias Bernard committed
53 54 55

## License
AGPLv3, because freeeeeeedom