From ac8bb3cbf45a44d1fedf057cd3ea09285f167530 Mon Sep 17 00:00:00 2001 From: Remy Moll <me@moll.re> Date: Sun, 15 Dec 2024 13:41:28 +0100 Subject: [PATCH] fill in some content --- frontend/README.md | 34 ++++++++++++------- .../android/en-US/full_description.txt | 12 +++---- .../fastlane/metadata/en-US/description.txt | 6 ++++ .../ios/fastlane/metadata/en-US/keywords.txt | 2 +- .../fastlane/metadata/en-US/marketing_url.txt | 2 +- frontend/ios/fastlane/metadata/en-US/name.txt | 2 +- .../fastlane/metadata/en-US/privacy_url.txt | 2 +- .../metadata/en-US/promotional_text.txt | 2 +- .../ios/fastlane/metadata/en-US/subtitle.txt | 2 +- 9 files changed, 39 insertions(+), 25 deletions(-) diff --git a/frontend/README.md b/frontend/README.md index 740cf1e..6c268f0 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -17,15 +17,9 @@ flutter pub get ``` ## Development -### ... -### Icons and logos -The application uses a custom launcher icon and splash screen. These are managed platform-independently using the `flutter_launcher_icons` package. - -To update the icons, change the `flutter_launcher_icons.yaml` configuration file. Especially the `image_path` is relevant. Then run -```bash -dart run flutter_launcher_icons -``` +### TODO +## Deployment and metadata ### Deploying a new version To truly deploy a new version of the application, i.e. to the official app stores, a special CI step is required. This listens for new tags. To create a new tag position yourself on the main branch and run ```bash @@ -34,6 +28,18 @@ git push origin v<name> ``` We adhere to the [Semantic Versioning](https://semver.org/) standard, so the tag should be of the form `v0.1.8` for example. +### Icons and logos +The application uses a custom launcher icon and splash screen. These are managed platform-independently using the `flutter_launcher_icons` package. + +To update the icons, change the `flutter_launcher_icons.yaml` configuration file. Especially the `image_path` is relevant. Then run +```bash +dart run flutter_launcher_icons +``` +### Other metadata +Fastlane provides mechanisms to update the metadata of the application. This includes the name, description, screenshots, etc. The metadata is stored in the `fastlane/metadata` directory of both the `android`and the `ios` version of the application. Both versions have different structures but **they should be kept in sync**. For more information see the [fastlane documentation](https://docs.fastlane.tools/): +- https://docs.fastlane.tools/actions/deliver/ +- https://docs.fastlane.tools/actions/supply/ + ## Fastlane - in depth The application is deployed to the Google Play Store and the Apple App Store using fastlane: [https://docs.fastlane.tools/](https://docs.fastlane.tools/) @@ -46,16 +52,18 @@ bundle exec fastlane <lane> ``` This is reused in the CI/CD pipeline to automate the deployment process. -Secrets used by fastlane are stored on hashicorp vault and are fetched by the CI/CD pipeline. See below. +Secrets used by fastlane are stored as repository. ## Secrets These are mostly used by the CI/CD pipeline to deploy the application. The main usage for github actions is documented under [https://github.com/hashicorp/vault-action](https://github.com/hashicorp/vault-action). **Platform-specific secrets** are used by the CI/CD pipeline to deploy to the respective app stores. -- `GOOGLE_MAPS_API_KEY` is used to authenticate with the Google Maps API and is scoped to the android platform +- `ANDROID_GOOGLE_MAPS_API_KEY` is used to authenticate with the Google Maps API and is scoped to the android platform - `ANDROID_KEYSTORE` is used to sign the android apk - `ANDROID_GOOGLE_KEY` is used to authenticate with the Google Play Store api - `IOS_GOOGLE_MAPS_API_KEY` is used to authenticate with the Google Maps API and is scoped to the ios platform -- `IOS_GOOGLE_...` -- `IOS_GOOGLE_...` -- `IOS_GOOGLE_...` \ No newline at end of file +- `IOS_ASC_ISSUER_ID` is used to authenticate with the App Store Connect API +- `IOS_ASC_KEY` as well +- `IOS_ASC_KEY_ID` as well +- `IOS_MATCH_PASSWORD` is used by fastlane match to download the certificates +- `IOS_MATCH_REPO_SSH_KEY_BASE64` is used to authenticate with the git repository where the certificates are stored diff --git a/frontend/android/fastlane/metadata/android/en-US/full_description.txt b/frontend/android/fastlane/metadata/android/en-US/full_description.txt index 9091b15..0869024 100644 --- a/frontend/android/fastlane/metadata/android/en-US/full_description.txt +++ b/frontend/android/fastlane/metadata/android/en-US/full_description.txt @@ -1,7 +1,7 @@ -AnyWay - plan city trips your way +AnyWay is an application that helps you plan truly unique city trips. When planning a new trip, you can specify <our> preferences and constraints and anyway generates a personalized itinerary just for you. -AnyWay is a mobile application that helps users plan city trips. The app allows users to specify their preferences and constraints, and then generates a personalized itinerary for them. The planning follows some guiding principles: -- **Personalization**:The user's preferences should be reflected in the choice of destinations. -- **Efficiency**:The itinerary should be optimized for the user's constraints. -- **Flexibility**: We aknowledge that tourism is a dynamic activity, and that users may want to change their plans on the go. -- **Discoverability**: Tourism is an inherently exploratory activity. Once a rough itinerary is generated, detours and spontaneous decisions should be encouraged. \ No newline at end of file +Anyway follows these core principles: +- **Personalization**: Trips should be match your interests - not just the most popular destinations. +- **Efficiency**: Don't just walk in circles! Anyway creates the most efficient route for you. +- **Flexibility**: Vacations are the time to be spontaneous. Anyway lets you update your plans on the go. +- **Discoverability**: Tourism means exploration. Anyway encourages you to take detours and make spontaneous decisions. diff --git a/frontend/ios/fastlane/metadata/en-US/description.txt b/frontend/ios/fastlane/metadata/en-US/description.txt index 8b13789..0869024 100644 --- a/frontend/ios/fastlane/metadata/en-US/description.txt +++ b/frontend/ios/fastlane/metadata/en-US/description.txt @@ -1 +1,7 @@ +AnyWay is an application that helps you plan truly unique city trips. When planning a new trip, you can specify <our> preferences and constraints and anyway generates a personalized itinerary just for you. +Anyway follows these core principles: +- **Personalization**: Trips should be match your interests - not just the most popular destinations. +- **Efficiency**: Don't just walk in circles! Anyway creates the most efficient route for you. +- **Flexibility**: Vacations are the time to be spontaneous. Anyway lets you update your plans on the go. +- **Discoverability**: Tourism means exploration. Anyway encourages you to take detours and make spontaneous decisions. diff --git a/frontend/ios/fastlane/metadata/en-US/keywords.txt b/frontend/ios/fastlane/metadata/en-US/keywords.txt index 8b13789..0da5646 100644 --- a/frontend/ios/fastlane/metadata/en-US/keywords.txt +++ b/frontend/ios/fastlane/metadata/en-US/keywords.txt @@ -1 +1 @@ - +tourism, cities, travel, guide diff --git a/frontend/ios/fastlane/metadata/en-US/marketing_url.txt b/frontend/ios/fastlane/metadata/en-US/marketing_url.txt index 8b13789..427469c 100644 --- a/frontend/ios/fastlane/metadata/en-US/marketing_url.txt +++ b/frontend/ios/fastlane/metadata/en-US/marketing_url.txt @@ -1 +1 @@ - +https://anydev.info diff --git a/frontend/ios/fastlane/metadata/en-US/name.txt b/frontend/ios/fastlane/metadata/en-US/name.txt index 8d1357c..4366249 100644 --- a/frontend/ios/fastlane/metadata/en-US/name.txt +++ b/frontend/ios/fastlane/metadata/en-US/name.txt @@ -1 +1 @@ -Testing RM +AnyWay \ No newline at end of file diff --git a/frontend/ios/fastlane/metadata/en-US/privacy_url.txt b/frontend/ios/fastlane/metadata/en-US/privacy_url.txt index 8b13789..648281d 100644 --- a/frontend/ios/fastlane/metadata/en-US/privacy_url.txt +++ b/frontend/ios/fastlane/metadata/en-US/privacy_url.txt @@ -1 +1 @@ - +https://anydev.info/privacy diff --git a/frontend/ios/fastlane/metadata/en-US/promotional_text.txt b/frontend/ios/fastlane/metadata/en-US/promotional_text.txt index 8b13789..77a635f 100644 --- a/frontend/ios/fastlane/metadata/en-US/promotional_text.txt +++ b/frontend/ios/fastlane/metadata/en-US/promotional_text.txt @@ -1 +1 @@ - +AnyWay - plan city trips your way! diff --git a/frontend/ios/fastlane/metadata/en-US/subtitle.txt b/frontend/ios/fastlane/metadata/en-US/subtitle.txt index 8b13789..42d9940 100644 --- a/frontend/ios/fastlane/metadata/en-US/subtitle.txt +++ b/frontend/ios/fastlane/metadata/en-US/subtitle.txt @@ -1 +1 @@ - +Plan city trips your way!