README.md 1.31 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
14
15
16
17
18
19
20
21
22
23
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
Julian Sparber's avatar
Julian Sparber committed
24
#### Archlinux
Julian Sparber's avatar
Julian Sparber committed
25
```
26
  pacman -S base-devel libsoup avahi gtk3 meson
27
  git clone https://github.com/frac-tion/teleport.git
28
29
  cd teleport
  ./configure
Julian Sparber's avatar
Julian Sparber committed
30
  make
31
  ./_build/src/teleport
Julian Sparber's avatar
Julian Sparber committed
32
```
Julian Sparber's avatar
Julian Sparber committed
33
#### Ubuntu
34
```
35
  apt install pkg-config libsoup2.4-dev libavahi-client3 libgtk-3-dev meson
36
  git clone https://github.com/frac-tion/teleport.git
37
38
  cd teleport
  ./configure
39
  make
40
  ./_build/src/teleport
41
42
```

Tobias Bernard's avatar
Tobias Bernard committed
43
44
45

## License
AGPLv3, because freeeeeeedom