Skip to content

Repository files navigation

Wormhole

Latest Release pipeline status

An open source Android App for sending/receiveing files using the magic-wormhole protocol.

Get it on Google Play StoreGet it on IzzyOnDroid

Preview

Features

  • Open source: Lightweight, clean and secure.
  • Send/receive files via the magic-wormhole protocol
  • Generate QR code of receive code
  • Scan QR-Code of sender
  • Dark theme

Compatible Desktop Applications:

(feel free to add yours)

Development

Build app

Install Android SDK, Flutter and rustup.

You might want to set your Java version to <20:
add to your gradle.properties:
org.gradle.java.home=/usr/lib/jvm/java-17-openjdk/

Install Android ndk version 24.0.8215888:
sdkmanager "ndk;24.0.8215888"

Add rust Android targets:
rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android

Install cargo-ndk:
cargo install cargo-ndk

Build apk+appbundle:
make apk

Dev Linux build:
make linux

Format/Lint

Format source code:
make format

Lint source code:
make lint

Code generation

Generate translations:
make translation

Generate Flutter-Rust-Bridge code bindings:
make codegen

Cleanup

Clean build files:
make clean

Contribution

Every kind of contribution is welcome. :)

If you know other languages than English/German/Swedish feel free to add new translations in lib/l10n/. If you face any issues with the app you can gladly open an issue or fix it via a PR.

Used libraries

A great thanks to all the maintainers of the used libraries. Especially to magic-wormhole and flutter_rust_bridge.

Flutter

Rust

License

Copyright (C) 2023 Lukas Heiligenbrunner

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

About

magic wormhole Android client, forked from: https://gitlab.com/lukas-heiligenbrunner/wormhole

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages