From 490a04bb44d2aa858f6952418347a9f3c60a93aa Mon Sep 17 00:00:00 2001 From: TanelOrumaa <57108802+TanelOrumaa@users.noreply.github.com> Date: Sun, 10 Oct 2021 23:39:37 +0300 Subject: [PATCH 1/3] Update Readme with information on how to run the app --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 382733b..afbd642 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,25 @@ This is a proof-of-concept project for creating an Android app for authenticating yourself using an NFC-enabled Estonian ID card. This project will be created for the University of Tartu course "Software project". +### Requirements to use the application +* The smartphone's operating system must be Android 8.0 or newer +* The smartphone must support NFC technology and it must be enabled +* The user must have an Estonian ID card with NFC capability (issued since 2018) + +_Knowledge of Estonian might be useful as the application is in Estonian language at the moment. The English language support will be added during the iteration 3. If one does not understand Estonian then the guide at the bottom of the release notes might be useful._ + +### Installing the application on the phone +The first option is to open the MobileAuthApp folder of the project on the Android Studio and use the smartphone instead of an emulator (the application does not work with emulators because real ID card has to be scanned, which an emulator can not do) to run the application. This way the application gets installed on the phone automatically. + +More information about using real devices with Android studio: https://developer.android.com/studio/run/device + +The second and more reliable option is to get the .apk that is generated under the Artifacts of GitHub Actions when the project is built. Download the .apk file and move it to the smartphone and install it (phone permissions might have to be changed because it is not installed through Google Play). After the application has been installed it should open as any other application. + +More info about installing third party applications on the Android phones: https://www.androidauthority.com/how-to-install-apks-31494/ + +**NB! Before using the application make sure that the NFC is enabled on the phone, otherwise information can not be read from the ID card.** + +### Wiki pages relevant for the "Software project" subject [Project Vision](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Project-Vision) [Release Notes](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Release-notes) From 4ae5d3c0c42f6e21e664058b91901390b9e3c991 Mon Sep 17 00:00:00 2001 From: TanelOrumaa <57108802+TanelOrumaa@users.noreply.github.com> Date: Sun, 10 Oct 2021 23:40:36 +0300 Subject: [PATCH 2/3] Changed formatting for Readme --- README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index afbd642..76c5f11 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,10 @@ More info about installing third party applications on the Android phones: https **NB! Before using the application make sure that the NFC is enabled on the phone, otherwise information can not be read from the ID card.** ### Wiki pages relevant for the "Software project" subject -[Project Vision](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Project-Vision) - -[Release Notes](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Release-notes) - -[Project tasks](https://tvp-mobile-authentication.atlassian.net/jira/software/projects/MOB/boards/1/backlog) (Ask Tanel for JIRA permissions if needed). - -[Project plan](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Project-plan) - -[Use Cases](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Use-Cases) *updated 08.10* - -[User stories](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/User-stories) - -[Use Case Tests](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Use-Case-Tests) +* [Project Vision](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Project-Vision) +* [Release Notes](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Release-notes) +* [Project tasks](https://tvp-mobile-authentication.atlassian.net/jira/software/projects/MOB/boards/1/backlog) (Ask Tanel for JIRA permissions if needed). +* [Project plan](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Project-plan) +* [Use Cases](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Use-Cases) *updated 08.10* +* [User stories](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/User-stories) +* [Use Case Tests](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Use-Case-Tests) From 96595d924b565c0155d37769561565cf13febfd0 Mon Sep 17 00:00:00 2001 From: TanelOrumaa <57108802+TanelOrumaa@users.noreply.github.com> Date: Sun, 10 Oct 2021 23:52:59 +0300 Subject: [PATCH 3/3] Added last updated times for wiki pages. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 76c5f11..9803eda 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,10 @@ More info about installing third party applications on the Android phones: https **NB! Before using the application make sure that the NFC is enabled on the phone, otherwise information can not be read from the ID card.** ### Wiki pages relevant for the "Software project" subject -* [Project Vision](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Project-Vision) -* [Release Notes](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Release-notes) +* [Project Vision](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Project-Vision) *last updated on 10.10* +* [Release Notes](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Release-notes) *last updated for iteration 2 on 10.10* * [Project tasks](https://tvp-mobile-authentication.atlassian.net/jira/software/projects/MOB/boards/1/backlog) (Ask Tanel for JIRA permissions if needed). -* [Project plan](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Project-plan) -* [Use Cases](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Use-Cases) *updated 08.10* -* [User stories](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/User-stories) -* [Use Case Tests](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Use-Case-Tests) +* [Project plan](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Project-plan) *last updated on 10.10* +* [Use Cases](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Use-Cases) *last updated on 10.10* +* [User stories](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/User-stories) *last updated on 10.10* +* [Use Case Tests](https://github.com/TanelOrumaa/Estonian-ID-card-mobile-authenticator-POC/wiki/Use-Case-Tests) *WIP*