From 64ed84bfa9b3aa80f8a648e3c2619bcbd5d03bb4 Mon Sep 17 00:00:00 2001 From: Emin Date: Mon, 30 Dec 2024 17:54:18 +0500 Subject: [PATCH] update readme --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c715c285e..1b9cf9b7f5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,29 @@ -# Tourism - +# Tourism Map Tajikistan This app is for Tajikistan tourists. It's based on open source app Organic map. +## Please Read all of this before continuing +Don't forget make changes to this file, when you make significant changes to navigation. +version of Android Studio I used: android-studio-2024.1.1.13-mac_arm.dmg +version of XCode I used: 16.1 + +## Navigation on Android +The first activity app starts is SplashActivity.java. There it navigates to MainActivity +where all of the data about Tajikistan places are located, +it has its own navigation system on Jetpack compose. +There we navigateToMapToDownloadIfNotPresent() and navigateToAuthIfNotAuthed() being called. +When map download is finished it will go to MainActivity. +When you sign in or up, it will navigate to MainActivity + +## Navigation on iOS +The first screen to be shown is Map screen (see MapsAppDelegate.mm). I (Emin) couldn't change it. +There's such logic in MapsAppDelegate.mm: +if(Tajikistan is loaded) { + if (token is nil) navigate to Auth (note: token is cleared when user signs out) + else navigate to TourismMain (Home) +} +In Auth when user signs in or up, it navigates to TourismMain +In TourismMain goes to auth if not authorized + ## Features of their map Organic Maps is the ultimate companion app for travellers, tourists, hikers, and cyclists: