Yubico Authenticator for Desktop (Windows, macOS and Linux) and Android
Go to file
Adam Velebil aef3987a8c
lockfile
2022-04-27 13:26:20 +02:00
.github/workflows bump action version, set architecture param 2022-04-20 16:27:14 +02:00
android logger example 2022-04-13 15:26:32 +02:00
assets/product-images Added sky c nfc image 2022-04-05 12:56:55 +02:00
doc Changes to macOS release and dmg instructions 2022-04-13 14:22:06 +02:00
integration_test add account test 2022-04-14 09:08:33 +02:00
lib Merge branch 'main' into feature/integration_tests 2022-04-27 11:09:18 +02:00
linux Update generated plugin files. 2022-04-04 15:15:05 +02:00
macos Update MacOS generated files. 2022-04-04 15:31:52 +02:00
pigeons review updates 2022-03-24 17:39:12 +01:00
resources Windows installer + resources directory 2022-03-15 15:09:39 +01:00
test Remove executable permission from files. 2021-11-19 09:19:16 +01:00
windows Update generated plugin files. 2022-04-04 15:15:05 +02:00
ykman-rpc Update python dependencies. 2022-04-05 17:53:05 +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 Remove executable permission from files. 2021-11-19 09:19:16 +01:00
analysis_options.yaml Enable lint check for unawaited_futures. 2022-01-25 12:46:51 +01:00
build-ykman.bat Update ykman and replace submodule with pyproject config. 2022-02-21 10:47:33 +01:00
build-ykman.sh Update ykman and replace submodule with pyproject config. 2022-02-21 10:47:33 +01:00
build.yaml Add start of navigation structure. 2021-11-22 14:00:23 +01:00
pubspec.lock lockfile 2022-04-27 13:26:20 +02:00
pubspec.yaml add account test 2022-04-14 09:08:33 +02:00
README.adoc Update README and add verison number in about. 2022-02-24 15:32:49 +01: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 ykman-rpc, as described in
the next section.


=== Building ykman-rpc
Requirements: Python >= 3.8 and Poetry.

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

NOTE: You will need to re-run `ykman-build.sh` if changes have been made to
ykman-rpc'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].