The source code for our video-on-demand app for iOS and Android.
Recommended editor: VS Code, because we have some default debug options set up in launch.json.
- Clone the submodules with
git submodule update --init. - Install flutter, then run
flutter doctor -vuntil it reports everything is OK. - Run in a terminal:
make pubgetall. This runsflutter pub getfor each package (kids, bccm_core, bccm_player). You may need to install make. - Inside lib/env/, duplicate the .env.dart.template file and rename it to .env.dart, and update the values according to the comments.
- You can now run the app, e.g. with Run > Start Debugging in VSCode
- 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.
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
- 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 datedate +%m%d%H%M%Y.%S"
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.
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.
You can find constants for colors, typography, etc. based on our design system under /lib/theme.
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.
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.
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.