lokinet-flutter-app/README.md

47 lines
931 B
Markdown
Raw Permalink Normal View History

2022-08-21 22:53:28 +02:00
# Lokinet on Android
2021-03-14 20:28:45 +01:00
2022-08-21 22:53:28 +02:00
An app to interact with Lokinet as a vpn tunnel for android.
2021-03-14 20:28:45 +01:00
2021-12-31 18:22:35 +01:00
[![Build Status](https://ci.oxen.rocks/api/badges/oxen-io/lokinet-flutter-app/status.svg)](https://ci.oxen.rocks/oxen-io/lokinet-flutter-app)
2021-06-23 17:42:30 +02:00
2021-04-12 15:07:19 +02:00
## building
2021-03-22 02:49:10 +01:00
2021-04-12 15:07:19 +02:00
build requirements:
2021-03-14 20:28:45 +01:00
2022-08-21 22:47:56 +02:00
* posix compliant build environment
* flutter
* gnu make
* cmake
* pkg-config
* git
* autotools
2021-03-14 20:28:45 +01:00
a one liner to install everything else:
$ sudo apt install make automake libtool pkg-config cmake git
2021-03-14 20:28:45 +01:00
### git submodules
2021-04-12 15:07:19 +02:00
before building make sure to update the submodules:
2021-04-12 15:07:19 +02:00
$ git submodule update --init --recursive
2021-04-12 15:07:19 +02:00
### flutter
install flutter with [asdf](https://github.com/asdf-vm/asdf):
$ asdf install
to build the project with flutter:
2021-04-12 15:07:19 +02:00
$ flutter build apk --debug
if succesful it will produce an apk at `build/app/outputs/flutter-apk/app-debug.apk` which you can run
2021-06-21 13:45:15 +02:00
2021-06-21 17:27:47 +02:00
## cleaning
2021-06-21 17:30:05 +02:00
to make the workspace pristine use:
2021-06-21 17:27:47 +02:00
2021-06-21 17:30:05 +02:00
$ ./contrib/clean.sh