README.md

DAS Client

DAS (Driver Advisory System) is a mobile application that provides all the required journey data to the train driver.

Supported platforms

Build and run

DAS Client has 3 distinct flavors: dev, inte and prod. Run them as follows:

fvm flutter run --flavor dev -t lib/main_dev.dart

fvm flutter run --flavor inte -t lib/main_inte.dart

fvm flutter run --flavor prod -t lib/main_prod.dart

Running Integration Tests

Instrumentation Tests do not use user authentication. Therefore the credentials must be provided as environment variables.

fvm flutter test --flavor dev --dart-define=MQTT_USERNAME=${MQTT_USERNAME} --dart-define=MQTT_PASSWORD=${MQTT_PASSWORD} integration_test/app_test.dart

Architecture

TODO

Localization

The app is available in three languages:

Localization terms/keys conform to the following format:

<PREFIX>_<CONTEXT?>_<LABEL>

The prefix is mandatory and indicates the scope of the term. Valid prefixes are:

Prefix	Scope	Description
c	Common	Common terms that can be used in the whole app
p	Page	Terms that belong to a specific page
w	Widget	Terms that bleong to a specific widget

The context is optional and indicate where a localization is used. When a localization is scoped to a page or widget, the context MUST be equal to the name of that page or widget. For example, localizations used on the login page would start with p_login_.

To generate the localization code, run the following command:

fvm flutter gen-l10n

Code style

This application uses the code style defined in the Flutter Wiki. The recommendations are mandatory and should always be followed unless there is a good reason not to do so. However, this must be approved by all developers.

Flutter SDK version

This app uses FVM to configure the Flutter SDK version.