2021-11-19 12:05:45 +03: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.
|
|
|
|
|
|
2022-05-09 13:48:08 +03:00
|
|
|
You will also need to provide a compiled version of the Helper, as described in
|
2022-02-24 16:09:58 +03:00
|
|
|
the next section.
|
2021-11-19 12:05:45 +03:00
|
|
|
|
|
|
|
|
|
2022-05-09 13:48:08 +03:00
|
|
|
=== Building the Yubico Authenticator Helper
|
2022-02-24 16:09:58 +03:00
|
|
|
Requirements: Python >= 3.8 and Poetry.
|
2021-11-19 12:05:45 +03:00
|
|
|
|
2022-05-09 13:48:08 +03:00
|
|
|
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).
|
2021-11-19 12:05:45 +03:00
|
|
|
|
2022-05-09 13:48:08 +03:00
|
|
|
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.
|
2021-11-19 12:05:45 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
=== 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].
|
