tree: 6d4beb565bd0e78afa5ede091599a2a4619a53de [path history] [tgz]
  1. assets/
  2. lib/
  3. test/
  4. web/
  5. .metadata
  6. analysis_options.yaml
  7. app.yaml
  8. build.gradle
  9. CONTRIBUTE.md
  10. Dockerfile
  11. gradle.properties
  12. l10n.yaml
  13. nginx_default.conf
  14. pubspec.lock
  15. pubspec.yaml
  16. README.md
  17. settings.gradle
playground/frontend/README.md

Apache Beam Playground

About

Beam Playground is an interactive environment to try out Beam transforms and examples. The vision for the Playground is to be a web application where users can try out Beam without having to install/initialize a Beam environment.

Getting Started

Run

See playground/README.md for details on requirements and setup.

The following command is used to build and serve the website locally:

$ flutter run

Build

Run the following command to generate a release build:

$ flutter build web

Tests

Playground tests may be run using next commands:

$ flutter pub run build_runner build

$ flutter test

Code style

Dart code should follow next code style. Code may be analyzed using this command:

$ flutter analyze

Code can be automatically reformatted using:

$ flutter format ./lib

Localization

To add a new localization, follow next steps:

  1. Create app_YOUR_LOCALE_CODE.arb file with your key-translation pairs, except description tags, in lib/l10n directory (use app_en.arb as example).

  2. Add Locale(‘YOUR_LOCALE_CODE’) object to static const locales variable in lib/l10n/l10n.dart file.

  3. Run the following command to generate a build and localization files:

$ flutter build web

Configuration

The app could be configured using gradle task (e.g. api url)

cd beam
./gradlew :playground:frontend:createConfig

For more information see See CONTRIBUTE.md

Additional

The full list of commands can be found here

Contribution guide

If you'd like to contribute to the Apache Beam Playground website, read our contribution guide where you can find detailed instructions on how to work with the playground.