Yubico Authenticator for Desktop (Windows, macOS and Linux) and Android
Go to file
2022-09-30 11:42:01 +02:00
.github Migrate to Flutter 3.3.2 2022-09-23 10:42:29 +02:00
android Merge PR #229. 2022-09-30 11:00:00 +02:00
assets add dialog header assets 2022-09-07 17:17:21 +02:00
doc Update documentation for Helper. 2022-05-09 12:48:08 +02:00
helper bump dev versions 2022-09-20 14:26:41 +02:00
integration_test theme preferences tests 2022-09-23 10:17:28 +02:00
lib Place shortcut in second line in tooltip. 2022-09-30 11:42:01 +02:00
linux set size 2022-09-26 11:59:07 +02:00
macos Migrate to Flutter 3.3.2 2022-09-23 10:42:29 +02:00
resources bump dev versions 2022-09-20 14:26:41 +02:00
test theme preferences tests 2022-09-23 10:17:28 +02:00
windows Migrate to Flutter 3.3.2 2022-09-23 10:42:29 +02:00
.flake8 Update ykman-rpc and fix set_mode. 2022-05-06 15:40:51 +02:00
.gitignore Remove executable permission from files. 2021-11-19 09:19:16 +01:00
.gitmodules Update ykman and replace submodule with pyproject config. 2022-02-21 10:47:33 +01:00
.metadata Update Flutter dependencies and use new versioning for Runner.rc. 2022-08-31 09:13:35 +02:00
analysis_options.yaml Enable use_super_parameters lint rule. 2022-05-12 12:05:18 +02:00
build-helper.bat Fix Windows license generation. 2022-06-14 09:28:14 +02:00
build-helper.sh Ensure pip is updated for venv to generate licenses. 2022-06-07 13:04:05 +02:00
build.yaml Add start of navigation structure. 2021-11-22 14:00:23 +01:00
create-dmg.sh Move creation of dmg to script 2022-06-28 15:58:36 +02:00
l10n.yaml Localization: first steps 2022-07-27 12:00:31 +02:00
pubspec.lock Update Flutter dependencies (flutter pub upgrade). 2022-09-23 10:54:51 +02:00
pubspec.yaml bump window_manager, build_runner, json_serializable 2022-09-22 16:03:12 +02:00
README.adoc Update documentation for Helper. 2022-05-09 12:48:08 +02:00
set-version.py force correct version name for macos builds 2022-09-22 14:37:06 +02:00

== Yubico Authenticator for Desktop

=== Requirements
You will need the Flutter SDK with enabled desktop support, see:
https://flutter.dev/desktop

Development has been done using the "Install from git" method of installing the
SDK, from the "beta" channel.

You will also need to provide a compiled version of the Helper, as described in
the next section.


=== Building the Yubico Authenticator Helper
Requirements: Python >= 3.8 and Poetry.

The GUI requires a compiled version of Helper to run, which is built from the
sources in helper/ in this repository. This needs to be build prior to running
`flutter build` or `flutter run`, by running `build-helper.sh` (or
`build-helper.bat` on Windows).

NOTE: You will need to re-run `ykman-helper.sh` if changes have been made to
Helper's code, or if `flutter clean` has been run.


=== Running the app
To start the app, run:

  flutter run -d <os>

where <os> is "windows", "macos", or "linux". You can add the `--release` flag
to run a release build instead of debug. Builds of the app will be create under
`build/<os>/`.


=== Running tests
Tests can be run with the command:

  flutter test


=== Packaging for MacOS
See link:doc/MacOS_Packaging.adoc[MacOS Packaging].