README.md 1.78 KB
Newer Older
1
# la_app_xos
2

3
The Application that handles the connection between LogAir devices and LogAir's servers, as well as consulting the data.
4

5
## Requirements
6

7 8
- Dart
- Flutter SDK
9

10
## Before Running
11

12 13
```bash
flutter pub get
14 15
flutter pub pub run intl_translation:extract_to_arb --output-dir=lib/localization/l10n lib/localization/localization.dart
flutter pub pub run intl_translation:generate_from_arb --output-dir=lib/localization/l10n --no-use-deferred-loading lib/localization/localization.dart lib/localization/l10n/intl_en.arb lib/localization/l10n/intl_fr.arb
16
```
17

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
## Documentation

You can generate the application documentation yourself using the following command :

```bash
dartdoc
```

<details>
  <summary>In case of "dartdoc failed: Invalid argument(s): join(null, "bin", "cache", "dart-sdk")"</summary>

  Set the following environment variable:

  ```bash
  FLUTTER_ROOT=<path_to_flutter_root_folder>
  ```
  
</details>

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
## File Structure

The project is divided in multiple components:

- `localization` contains the code enabling the software to transition from one locale to another:
  - `l10n`: Language files.
- `logic` represents logical elements (advanced data types specific to the software's function):
  - `controllers`: Fine control over a Widget even from outside of its scope ;
  - `handlers`: Fine control over a logic segment from any scope.
- `services` contains code enabling the access to platform side content ;
- `ui` contains code for the Widgets ie. the Graphical components of the software ;
  - `animation`: Transitions between pages ;
  - `components`: Various tree end Widgets ;
  - `dialog`: Dialogs for user interaction ;
  - `routes`: Widget Tree root elements.
- `utils` contains decluttering code :
  - `enums`: type representation ;