I/O FLIP
An AI-designed card game built with Flutter and Firebase for Google I/O 2023.
Try it now and learn about how itβs made.
Built by Very Good Ventures in partnership with Google
Created using Very Good CLI π€
Getting Started π
This project contains 3 flavors:
- development
- staging
- production
To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:
# Development $ flutter run --flavor development --target lib/main_development.dart # Staging $ flutter run --flavor staging --target lib/main_staging.dart # Production $ flutter run --flavor production --target lib/main_production.dart
*I/O FLIP works on Web for desktop and mobile.
Loading initial data into database
Check the data loader docs for documentation on how the initial data is loaded.
Running the loading testing bot locally
Flop is a loading testing bot written in Flutter that runs on web meant to help testing the scaling of the backend of the game.
To execute it in the staging environment, open a terminal an execute:
./scripts/start_flop_webserver.sh <ENCRYPTION_KEY> <ENCRYPTION_IV> <RECAPTCHA_KEY> <APPCHECK_DEBUG_TOKEN>
You will be able to open the url where Flop started and check the progress of the bot run.
Which page represents one instance of Flop, to start several instance at the same time, the scripts/spam_flop.sh
can be used, this scripts needs to receive the port where Flop started, so assuming that flop is running on http://localhost:54678
, run:
./scripts/spam_flop.sh 54678
The same can be accomplished by using the army.html
page that is bundled in the in it. When loaded you will be able to select how many Flop instances to load, and it is also possible to autoload instances of the bot by adding a # with the number of desired bots to spawn.
Running Tests π§ͺ
To run all unit and widget tests use the following command:
$ flutter test --coverage --test-randomize-ordering-seed random
To view the generated coverage report you can use lcov.
# Generate Coverage Report $ genhtml coverage/lcov.info -o coverage/ # Open Coverage Report $ open coverage/index.html
Working with Translations π
This project relies on flutter_localizations and follows the official internationalization guide for Flutter.
Adding Strings
- To add a new localizable string, open the
app_en.arb
file atlib/l10n/arb/app_en.arb
.
{ "@@locale": "en", "counterAppBarTitle": "Counter", "@counterAppBarTitle": { "description": "Text shown in the AppBar of the Counter Page" } }
- Then add a new key/value and description
{ "@@locale": "en", "counterAppBarTitle": "Counter", "@counterAppBarTitle": { "description": "Text shown in the AppBar of the Counter Page" }, "helloWorld": "Hello World", "@helloWorld": { "description": "Hello World Text" } }
- Use the new string
import 'package:io_flip/l10n/l10n.dart'; @override Widget build(BuildContext context) { final l10n = context.l10n; return Text(l10n.helloWorld); }
Adding Supported Locales
Update the CFBundleLocalizations
array in the Info.plist
at ios/Runner/Info.plist
to include the new locale.
... <key>CFBundleLocalizations</key> <array> <string>en</string> <string>es</string> </array> ...
Adding Translations
- For each supported locale, add a new ARB file in
lib/l10n/arb
.
βββ l10n β βββ arb β β βββ app_en.arb β β βββ app_es.arb
- Add the translated strings to each
.arb
file:
app_en.arb
{ "@@locale": "en", "counterAppBarTitle": "Counter", "@counterAppBarTitle": { "description": "Text shown in the AppBar of the Counter Page" } }
app_es.arb
{ "@@locale": "es", "counterAppBarTitle": "Contador", "@counterAppBarTitle": { "description": "Texto mostrado en la AppBar de la pΓ‘gina del contador" } }