Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 3.43 KB

README.md

File metadata and controls

74 lines (47 loc) · 3.43 KB
Raw

BCC Media App

The source code for our video-on-demand app for iOS and Android.

Development

Initial setup

Recommended editor: VS Code, because we have some default debug options set up in launch.json.

  1. Clone the submodules with git submodule update --init.
  2. Install flutter, then run flutter doctor -v until it reports everything is OK.
  3. Run in a terminal: make pubgetall. This runs flutter pub get for each package (kids, bccm_core, bccm_player). You may need to install make.
  4. Inside lib/env/, duplicate the .env.dart.template file and rename it to .env.dart, and update the values according to the comments.
  5. You can now run the app, e.g. with Run > Start Debugging in VSCode
  6. For development, it's important to read the Code generation section below before you begin.

Tip

Run make help to see some of the util scripts we have.

Code generation

Some code is generated, for example routing and graphql queries. The generated files are often suffixed with .something.dart (e.g. .g.dart). To ensure your code is updated while developing, run the build_runner watcher:

dart run build_runner watch --delete-conflicting-outputs

Troubleshooting

  • Android: "Unknown error" on login, issues with ssl, etc.: Sometimes the android emulator's clock goes out of sync. You can run this adb command to update the clock: adb shell "su 0 date date +%m%d%H%M%Y.%S"

Tests

UI Tests

We are using Maestro for end-to-end UI tests. See .maestro/README.md. These use a normal build of the app to test the most critical user flows, e.g. logging in and then playing the livestream. Most of the tests run during the release pipeline for the app.

App architecture details

Core library

The bccm_core package is located at /submodules/bccm_core as a submodule, and linked in pubspec.yaml to the local path for convenience. This is where most of the core functionality is, e.g. graphql, auth, push, many utils, etc. Anything that needs to be shared with other apps should be a part of the bccm_core package.

Styling

You can find constants for colors, typography, etc. based on our design system under /lib/theme.

Player library

We are maintaining a standalone player library to manage the native playback and chromecast code. It's located at /submodules/bccm_player as a git submodule for convenience.

Navigation architecture

We are using auto_route, but for deep linking we are using app_links, as it's less magical and more reliable than flutter's built-in solution for that. We have some special routes, e.g. /r/, but these are only handled through a custom navigateNamedFromRoot() function.

Translations

We are using Crowdin for translations. In order to upload or download translations you need to have a personal token and the crowdin cli tool.

You need to put the token into a CROWDIN_TOKEN environment variable. Then you can run crowdin upload or crowdin download, e.g CROWDIN_TOKEN=abc123 crowdin download. The config comes from the ./crowdin.yml file

After downloading the translations into the project you also need to run flutter gen-l10n, which will generate .dart files in the same folder as the .arb files, based on /l10n.yaml.