Yubico/yubioath-flutter
1
1
Fork 0
mirror of https://github.com/Yubico/yubioath-flutter.git synced 2024-12-23 10:11:52 +03:00
Code Issues Packages Projects Releases Wiki Activity
Yubico Authenticator for Desktop (Windows, macOS and Linux) and Android
573 Commits 136 Branches 70 Tags 52 MiB
Dart 75.9%
Kotlin 14.8%
Python 6%
C++ 1.3%
CMake 1%
Other 0.6%
c3b895133e
Go to file
Dain Nilsson c3b895133e
Bump Python dependencies.
2022-05-13 09:05:07 +02:00
.github Use Flutter stable in Github Actions. 2022-05-12 08:36:47 +02:00
android regenerate pigeon 2022-05-12 11:06:51 +02:00
assets/product-images Added sky c nfc image 2022-04-05 12:56:55 +02:00
doc Update documentation for Helper. 2022-05-09 12:48:08 +02:00
helper Bump Python dependencies. 2022-05-13 09:05:07 +02:00
integration_test Fix lint warnings. 2022-05-12 08:34:51 +02:00
lib Use enhanced enums to replace enum extensions. 2022-05-12 12:05:20 +02:00
linux Update platform builds to use new helper. 2022-05-06 15:48:53 +02:00
macos Update platform builds to use new helper. 2022-05-06 15:48:53 +02:00
pigeons review updates 2022-03-24 17:39:12 +01:00
resources desktop entry file for linux 2022-05-05 15:21:33 +02:00
test Remove executable permission from files. 2021-11-19 09:19:16 +01:00
windows Update platform builds to use new helper. 2022-05-06 15:48:53 +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 Remove executable permission from files. 2021-11-19 09:19:16 +01:00
analysis_options.yaml Enable use_super_parameters lint rule. 2022-05-12 12:05:18 +02:00
build-helper.bat Rename RPC to Yubico Authenticator Helper. 2022-05-06 15:48:52 +02:00
build-helper.sh Rename RPC to Yubico Authenticator Helper. 2022-05-06 15:48:52 +02:00
build.yaml Add start of navigation structure. 2021-11-22 14:00:23 +01:00
pubspec.lock force analyzer version, upgrade freezed 2022-05-12 11:05:19 +02:00
pubspec.yaml force analyzer version, upgrade freezed 2022-05-12 11:05:19 +02:00
README.adoc Update documentation for Helper. 2022-05-09 12:48:08 +02:00

README.adoc 

== 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].