We apreciate any kind of contributions to AuthPass 😅️ Check out the article on helping support AuthPass on our website.
If you want to contribute documentatin or code, never hesitate to get in contact.
AuthPass is based on Flutter, so you should get familiar with the dart programming language as well as flutter itself. You can checkout the flutter website at https://flutter.dev/
If you have never used flutter before you might want to walk through a few codelabs before getting into AuthPass.
AuthPass makes heavy use of submodules right now. If you fork the repository you might experience a few
permission denied errors when you clone using ssh. To work around those you might need to add the follwing to your ~/.gitconfig:
[url "https://github.com/"]
insteadOf = [email protected]:
[url "[email protected]:"]
pushInsteadOf = "https://github.com/"
(If you don't want it for all github repositories, you might only configure it for github:hpoul/ and github:authpass/).
-
Download Flutter and make sure
flutter doctorshows no errors.- Latest Flutter stable or beta channel should typically work, check out authpass/_tools/install_flutter.sh for what's being used in the CI.
-
Clone the repository
git clone https://github.com/authpass/authpass.git(or better yet, create your own fork to make later creating Pull Requests easier). -
Change to the
authpass/subdirectory:git clone https://github.com/authpass/authpass.git cd authpass/authpass -
Launch AuthPass
flutter run -t lib/env/development.dart
You are required to select a specific target file,
usually this will be lib/env/develompent.dart.
For android you have to add an additional flavor:
flutter run --target=lib/env/development.dart --flavor=playstore
Make sure to follow common dart coding conventions, and follow all lints provided
by analysis_options.yaml and activate auto-formatting using dartfmt.