child of #24

Example usage of how to embed flutter in project

possibly in README of every project?

There are a few small differences between the coding style used in production apps and the style Flutter DevRel uses in their samples. I just wanted to call out a couple here and ask that they be incorporated into Flutter module.

• The DevRel team has a standard analysis_options setup that we use across samples. We'd like for this project to match.
• We generally avoid using underscores to represent unused parameters. This is so that readers learning Flutter's APIs from the code can see what the purpose of the parameter is, even if it's unused in that particular instance. Right now I only see one parameter that's been done this way. Renaming that one to "context" can help readers understand that BlocProvider uses a context when creating its Bloc or Cubit at a particular spot in the tree.

It's possible there may be a few more as the project advances. I'll try to call them out as early as possible, and y'all should feel free to ask any questions you have.

We need to have the CI/CD pipeline run a few tests on aspects of the container app, to ensure features work properly.

We need to have the build pipeline run unit and widget tests on the module to ensure the code works properly.

We need to have a CODEOWNERS file with Dominik and Felix listed, so that they are automatically added to the PRs.

child of #3

The design needs the following:

• Capture Screen
• Completion Screen

child of #5

Update the native container to use the news feed design from #12

Parent Task: #17

We need to create a Web native app, according to the design specifications.

Child Task: #33 , #44, #49, #59

child of #5

Mock data layer, enabled by default

• Firebase data layer, in lieu of mock data layer, that works out of the box once Firebase credentials are added

Deliverables:

• Code related to mock and Firebase data layers

Detailed task is:
#14

We need to write a blog post for marketing purposes that can go on the VGV Blog.

All the code for the project uploaded and deployed to Github Repo, according to our standard conventions.
Must be reviewed and discussed with Google to ensure smooth handover.

We need to have a Firebase data layer that starts working immediately after the user updates the Firebase credentials. It will be mocked until those are changed.

Child Tasks: #45, #35

The App NPS will have

1. An initial rating button panel - 1 through 5
2. A secondary suite of buttons that appear after the first selection
3. A "Report An Issue" button
4. A submit button
5. A Thank You screen after submission

• The Flutter module should be built by CD in such a way that it's ready to be imported into native applications as a library, with no need for the Flutter SDK or source code on the consuming machine.

• Builds of the application should be produced as GitHub Actions artifacts and links to the latest copies should be in the project README for easy access.

child of #15

Use Flutter NPS module in existing native app

Develop NPS UX

• Integrate with mock and firebase data layers

• Manage native app integration and lifecycle

• App build system to make Flutter module easily integrated to native container apps

• There are Android docs and iOS docs for this approach, and the web application can simply include the module in a subdirectory

Deliverables:

• Flutter NPS module, easily imported as AAR/framework/other method

Detailed task is:
#18

child of #5
depends on finishing of #45

Update the native container to use the news feed design from #12

Parent Task: #16

Child of #24

Following the instructions in the README and running the app on iOS results in the following error when starting the Flutter Engine

2022-04-18 15:30:29.359139-0500 newsfeed_app[10857:1383976] Failed to find assets path for "Frameworks/App.framework/flutter_assets"
2022-04-18 15:30:29.359564-0500 newsfeed_app[10857:1383976] Metal API Validation Enabled
2022-04-18 15:30:29.408371-0500 newsfeed_app[10857:1384246] [VERBOSE-2:engine.cc(197)] Engine run configuration was invalid.
2022-04-18 15:30:29.408579-0500 newsfeed_app[10857:1384246] [VERBOSE-2:shell.cc(580)] Could not launch engine with configuration.
2022-04-18 15:30:29.497715-0500 newsfeed_app[10857:1384272] flutter: Observatory listening on http://127.0.0.1:49572/-IguXrqyB5Y=/

child of #16

child of #5

Create very_good_start project template

child of #15

Create GitHub action for:

• unit testing and making sure we have 100% test coverage
• using flutter module

We need to have Google (PoC: Andrew Brogdon) sign off on the designs.

We need to build a native iOS app container according to the design specifications.

Child Task: #31, #34, #47, #57

Documentation provided with the module should instruct users on how to quickly create a Firebase project, enable Cloud Firestore, and paste their credentials into the code.

Documentation for Flutter module, including how to build the app, package the module, and customize the module

Documentation for each native container app, including where in the project the module is invoked

Linked Tasks: #36, #37, #38

child of #16

Create GitHub action for:

• unit testing and making sure we have 100% test coverage
• using flutter module

parent of #10
Waiting for the clarificaiton

All app code deployed in a Github repo

CI/CD that executes unit and widget tests for Flutter module

CI/CD that executes at least a few tests for each native container app

CI/CD to build Flutter module for easy import into Native applications

• The Flutter module should be built by CD in such a way that it's ready to be imported into native applications as a library, with no need for the Flutter SDK or source code on the consuming machine.

• Builds of the application should be produced as GitHub Actions artifacts and links to the latest copies should be in the project README for easy access.

Deliverables:

• CI/CD scripts for tests

• CI/CD scripts for builds

Detailed tasks are:
#19, #20, #21, & #22

Same basic feature set for container app via:

• Native Android development

• Native iOS development

• Native Web app development

Deliverables:

• Native Android container app code
• Native iOS container app code
• Web container app code

Detailed tasks are:
#15, #16, & #17

child of #24

Code coverage setup, where to access very good cli etc.

We need to create the NPS Module that:

• Is integrated with the mock and Firebase data layers

• Manages native app integration and lifecycle

• Uses an app build system to make Flutter module easily integrated to native container apps

Note: There are Android docs and iOS docs for this approach, and the web application can simply include the module in a subdirectory

There needs to be proper UX / UI designs for the container apps

Project README that explains what the project is, what the purpose is, and how to use it.

We need to create an Android native container app, according to the design specifications.

Child task: #32, #46, #48, #58

child of #15

Define native container app minimum required feature set

• Native implementation of the default Flutter counter app

• The UI for the app will be appropriately adapted to the platform on which it's designed to run

• App will have a clear "moment" to invoke the Flutter NPS module

Define app NPS required feature set

Define module native integration approach

• Play around with what's possible, come up with options for how to proceed with actual coding.

Deliverables:
Required features and delivery success criteria

Detailed Tasks are:
#8, #9, & #10

• Native implementation of the default Flutter counter app

• The UI for the app will be appropriately adapted to the platform on which it's designed to run:
  Figma Design

• App will have a clear "moment" to invoke the Flutter NPS module

Update the native container to use the news feed design from #12

Parent Task: #15

UX / UI designs for NPS capture

• Capture screen

• Loading state

• Completion state

UX / UI designs for native container apps’ UX

Google review and design approval

Deliverables:

• UI design for the module

• UI design for each native container app

Detailed tasks are:
#11, #12, and & #13

README explaining project and its purpose

Instructions to build, run, and customize

Documentation provided with the module should instruct users on how to quickly create a Firebase project, enable Cloud Firestore, and paste their credentials into the code.

Documentation for Flutter module, including how to build the app, package the module, and customize the module

Documentation for each native container app, including where in the project the module is invoked

Marketing blog post

Deliverables:

• README documentation

• Source code documentation

• Marketing blog post

child of #17

Create GitHub action for:

• unit testing and making sure we have 100% test coverage
• using flutter module

child of #5

child of #16

child of #17

Implement Flutter module into web with iframe

child of #17

We will be using the standard approach to integrate the NPS module into the container app.
https://docs.flutter.dev/development/add-to-app