Yubico/yubioath-flutter
1
1
Fork 0
mirror of https://github.com/Yubico/yubioath-flutter.git synced 2024-12-22 17:51:29 +03:00
Code Issues Packages Projects Releases Wiki Activity
Yubico Authenticator for Desktop (Windows, macOS and Linux) and Android
29 Commits 136 Branches 70 Tags 52 MiB
Dart 75.9%
Kotlin 14.8%
Python 6%
C++ 1.3%
CMake 1%
Other 0.6%
a2aec75f0c
Go to file
Alexandru Geana a2aec75f0c Add Github action to scan dart dependencies 
Dependabot does not currently support Dart projects. As such, a
temporary alternative is to use the `pub outdated` command combined with
a Github action which runs at regular intervals (currently once a day).

The open issue where Dart support in Dependabot is being tracked is
https://github.com/dependabot/dependabot-core/issues/2166
2021-11-25 15:58:18 +00:00
.github/workflows Add Github action to scan dart dependencies 2021-11-25 15:58:18 +00:00
assets/product-images Add product images. 2021-11-24 13:28:38 +01:00
doc Update README 2021-11-19 10:55:43 +01:00
lib Fix expired circle timer. 2021-11-25 11:53:19 +01:00
linux Update native files. 2021-11-19 13:31:46 +01:00
macos Update native files. 2021-11-19 13:31:46 +01:00
test Remove executable permission from files. 2021-11-19 09:19:16 +01:00
windows Update native files. 2021-11-19 13:31:46 +01:00
yubikey-manager@7b74d03f53 Fix logging tracebacks from RPC. 2021-11-25 11:35:31 +01:00
.gitignore Remove executable permission from files. 2021-11-19 09:19:16 +01:00
.gitmodules Add rpc submodule. 2021-11-19 09:08:04 +01:00
.metadata Remove executable permission from files. 2021-11-19 09:19:16 +01:00
analysis_options.yaml Fix linting errors. 2021-11-22 14:00:25 +01:00
build-ykman.bat Add rpc submodule. 2021-11-19 09:08:04 +01:00
build-ykman.sh Add rpc submodule. 2021-11-19 09:08:04 +01:00
build.yaml Add start of navigation structure. 2021-11-22 14:00:23 +01:00
pubspec.lock Support changing log level. 2021-11-24 11:42:24 +01:00
pubspec.yaml Add product images. 2021-11-24 13:28:38 +01:00
README.adoc Update README 2021-11-19 10:55:43 +01: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 ykman CLI. This can
either be built locally (see the next section), or manually downloaded and
placed in `build/<os>/ykman/`. Builds are available for download from GitHub
Actions in the `yubikey-manager` project.


=== Building the ykman CLI locally
Requirements: Python >= 3.6 and Poetry.

The GUI requires a compiled version of the ykman CLI to run, which is build
using pyinstaller from the yubikey-manager submodule in this repository. The
`build-ykman.sh` (`build-ykman.bat` on Windows) script in this repository will
take care of this, producing a build in `build/<os>/ykman` which will then be
included in the main GUI. See the `yubikey-manager` project documentation for
any build requirements needed in this step.

For faster development when making modifications to the CLI, you can skip the
re-compilation step and instead set the `_YKMAN_PATH` environment variable to
the location of a `ykman` executable to run:

  _YKMAN_PATH="/path/to/ykman.exe" flutter run -d windows


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