# Say My Frame > Generate Flutter apps from independent modules. Say My Frame generates Flutter apps from independent modules, such as a router, tabs, dependency injection, a state manager, Firebase and screens, wired together and ready to run. Every page of this site is also in Markdown at its URL with `.md`, as listed below, and https://doc.saymyframe.com/llms-full.txt has all of them in one file. ## Introduction - [Introduction](https://doc.saymyframe.com/index.md): Say My Frame generates Flutter apps from independent modules, such as a router, tabs, dependency injection, a state manager, Firebase and screens, wired together and ready to run. ## Getting started - [Installation](https://doc.saymyframe.com/getting-started/installation.md): Install the SMF command line tool with Dart and check that it finds the Flutter SDK. - [Create your first app](https://doc.saymyframe.com/getting-started/first-app.md): Generate a Flutter app with smf create, answering its questions or passing everything on the command line. - [Tour of a generated app](https://doc.saymyframe.com/getting-started/generated-app.md): What smf create generates, file by file, and which module or role wrote each part. - [Finish the setup](https://doc.saymyframe.com/setup.md): The steps of setting up a generated app that only you can do, in the consoles of Apple, Google, Firebase and RevenueCat, click by click. - [In Xcode, sign the iOS app with your paid Apple Developer team](https://doc.saymyframe.com/setup/app-entry-ios-app-id.md): Sign the iOS app once in Xcode with your paid Apple Developer team, which registers its App ID with push messages and Sign in with Apple. - [Turn on Sign in with Apple in Firebase Authentication](https://doc.saymyframe.com/setup/firebase-auth-apple-provider.md): Turn on the Apple provider in Firebase Authentication, so that the app can sign users in with Apple. - [Give Firebase your Sign in with Apple key, so that deleting an account works](https://doc.saymyframe.com/setup/firebase-auth-apple-revocation.md): Make a key for Sign in with Apple and a Services ID, and enter both in Firebase, so that deleting an account that signs in with Apple works. - [Before releasing on Google Play, give Firebase the SHA of your release keys](https://doc.saymyframe.com/setup/firebase-auth-google-release-sha.md): Give Firebase the SHA-1 and SHA-256 of the keys that sign your releases on Google Play, so that sign-in with Google works in them. - [Give Firebase your Apple push key (APNs key)](https://doc.saymyframe.com/setup/firebase-messaging-apns-key.md): Make an APNs key in your Apple Developer account and upload it to Firebase, so that Firebase can send push messages to iPhones. - [Turn on Google Analytics in the Firebase project, unless it is on already](https://doc.saymyframe.com/setup/firebase-analytics-google-analytics.md): Turn on Google Analytics in the Firebase project, so that the events that the app logs show up there. - [Set up payments in App Store Connect and Google Play Console](https://doc.saymyframe.com/setup/purchases-store-agreements.md): Sign the Paid Apps Agreement in App Store Connect and set up a payments profile in Google Play Console, so that the app can sell. - [Create the products of your plans in App Store Connect and Google Play Console](https://doc.saymyframe.com/setup/purchases-store-products.md): Create a product for each plan in App Store Connect and Google Play Console: subscriptions with a free trial, and a purchase paid once. - [Set up the entitlement premium and the default offering in RevenueCat](https://doc.saymyframe.com/setup/revenuecat-entitlement-and-offering.md): Set up the entitlement premium and the default offering in RevenueCat, with a package for each plan. - [Copy the API keys of your RevenueCat apps into .env](https://doc.saymyframe.com/setup/revenuecat-api-keys.md): Add the App Store and Play Store apps to the RevenueCat project, and copy their public API keys and that of the Test Store into .env. - [Give RevenueCat your In-App Purchase key from App Store Connect](https://doc.saymyframe.com/setup/revenuecat-app-store-key.md): Make an In-App Purchase key in App Store Connect and upload it to RevenueCat, so that RevenueCat can check the purchases of the App Store. - [Give RevenueCat access to Google Play with a service account](https://doc.saymyframe.com/setup/revenuecat-play-service-account.md): Create a service account in Google Cloud, invite it to Play Console and upload its key to RevenueCat, so that RevenueCat can check the purchases of Google Play. - [Publish your terms of use and privacy policy and put their links into .env](https://doc.saymyframe.com/setup/paywall-legal-pages.md): Publish your terms of use and privacy policy, put their links into .env for the paywall, and give them to App Store Connect and Play Console. ## Guides - [Choosing modules](https://doc.saymyframe.com/guides/choosing-modules.md): The modules of SMF, the roles they provide, what SMF adds by itself, and how the modules combine. - [The smf create command](https://doc.saymyframe.com/guides/smf-create.md): Every option of smf create, when it asks questions, what --explain prints, and its exit codes. - [Flavors](https://doc.saymyframe.com/guides/flavors.md): The native flavors dev, staging and prod that every generated app has, how they install side by side, what a flutter command builds without --flavor, how code reads the flavor, the run configurations of the IDEs, and how to add or remove a flavor. - [Navigation](https://doc.saymyframe.com/guides/navigation.md): The typed navigation of a generated app, context.nav, how go, push and replace behave with and without tabs, what the guards of the routes do, and how to add a route of your own. - [Services and state](https://doc.saymyframe.com/guides/services.md): How the code of a generated app gets its services for events, analytics and crash reporting, with or without a DI container, and where state lives. - [Preferences and settings](https://doc.saymyframe.com/guides/preferences.md): How a generated app remembers settings between launches (not secrets), how your code keeps a setting there, and how the settings screen shows the settings of the app. - [Theme](https://doc.saymyframe.com/guides/theme.md): The light and the dark theme of a generated app, the theme mode that the user selects and the app remembers, and where to change each. - [Languages](https://doc.saymyframe.com/guides/languages.md): The languages of a generated app, how smf create chooses them, how code reads a text in the language of the app, how the user chooses a language, and how to add a text or a language. - [Sign-in](https://doc.saymyframe.com/guides/sign-in.md): Sign-in in a generated app, from the screens and the session to who may use the app without an account, the ways to sign in with Google and Apple, how code signs in and shows a failure, what keeps a user from a screen, and where the data of a guest moves. - [Notifications and push messages](https://doc.saymyframe.com/guides/notifications.md): Notifications and push messages in a generated app, from the permission and where the app asks for it to showing, scheduling and the taps, the address of the device and the messages of a backend. - [Purchases](https://doc.saymyframe.com/guides/purchases.md): Premium access in a generated app, from the plans of the current offer and how code buys and restores them to the screens only for users with the access, whose purchases they are once users sign in, and what the stores ask of a screen that sells. - [Values in .env](https://doc.saymyframe.com/guides/env.md): The values that you fill in after generating an app, such as the public key of a service, in .env at the root of the app, how to write them, how code reads them through AppEnv, and why no secret goes there. - [REST API](https://doc.saymyframe.com/guides/rest.md): How a generated app makes requests to its REST API through appRest, with the address in .env, typed answers with decoded, failures of a closed set, repeats, a cancel for each call, the token of the session, redirects, and tests with RestTestServer. - [App icon and splash screen](https://doc.saymyframe.com/guides/app-icon-and-splash.md): The icon of a generated app and the screen that the system shows while it starts, the four images in assets/branding that you replace, the commands that make the result, and what the default images show. - [CI](https://doc.saymyframe.com/guides/ci.md): The CI of a generated app, the checks on each push and a build of the Android app for one environment on request, with GitHub Actions, the values of each environment, tool/write_env.dart, and what stays with you, such as signing. - [Working with a coding agent](https://doc.saymyframe.com/guides/coding-agents.md): The guide for coding agents that every generated app has, AGENTS.md and CLAUDE.md, what its sections say and how to keep it true. - [Firebase](https://doc.saymyframe.com/guides/firebase.md): How SMF sets up Firebase for each flavor, from the checks of the machine and tool/configure_firebase.dart to what repeats for each Firebase project, what a flavor that is not configured does, Crashlytics and flutter build ipa, Google Analytics, the script that enables the sign-in methods of Firebase Authentication, and the APNs key of Cloud Messaging. - [Troubleshooting](https://doc.saymyframe.com/guides/troubleshooting.md): Common problems with smf create and the apps it generates, and what to do about them. ## Modules - [Modules](https://doc.saymyframe.com/modules.md): The modules that smf create offers, the roles they provide, and what each adds to an app. - [flutter_core](https://doc.saymyframe.com/modules/flutter-core.md): The module that creates the Flutter project every SMF app starts from, with the screen that an app starts on when no route starts it, and provides the app entry role. - [go_router](https://doc.saymyframe.com/modules/go-router.md): The module that routes the app with go_router and provides the router role. - [bottom_tabs](https://doc.saymyframe.com/modules/bottom-tabs.md): The module of the main navigation as tabs in a bar at the bottom, which provides the layout role. - [home](https://doc.saymyframe.com/modules/home.md): The feature module of the start screen of the app, at /home, a welcome to the developer of the app with the next steps. - [onboarding](https://doc.saymyframe.com/modules/onboarding.md): The module of the onboarding that a new user goes through on the first launch of the app, a feature with a guard of the routes that shows the steps of other modules and provides the onboarding screen role. - [settings](https://doc.saymyframe.com/modules/settings.md): The feature module of the settings screen of the app, at /settings, which shows the settings of the modules in one group and provides the settings screen role. - [sign_in](https://doc.saymyframe.com/modules/sign-in.md): The feature module of the sign-in screens of the app, with sign-in, sign-up and password reset for an email address and a password, a button for each other way to sign in of the app, the screen of the account and its entry on the settings screen, in a variant for BLoC and one for Riverpod. - [paywall](https://doc.saymyframe.com/modules/paywall.md): The feature module of the paywall of the app, which sells the premium access of the purchases role with the plans of the current offer, with the screen of the subscription, its row on the settings screen and its step in the onboarding, in a variant for BLoC and one for Riverpod. - [bloc](https://doc.saymyframe.com/modules/bloc.md): The module that manages the state of screens with BLoC and flutter_bloc, a provider of the state management role. - [riverpod](https://doc.saymyframe.com/modules/riverpod.md): The module that manages the state of screens with Riverpod 3, a provider of the state management role. - [material_theme](https://doc.saymyframe.com/modules/material-theme.md): The module of the light and the dark Material 3 theme of the app, with a palette, text styles and a bundled font, a provider of the theme role. - [launcher_icons](https://doc.saymyframe.com/modules/launcher-icons.md): The module that makes the icon of the app with flutter_launcher_icons, a provider of the app icon role, from two images in assets/branding that you replace. - [native_splash](https://doc.saymyframe.com/modules/native-splash.md): The module that makes the screen that the system shows while the app starts with flutter_native_splash, a provider of the splash role, from two images in assets/branding that you replace. - [gen_l10n](https://doc.saymyframe.com/modules/gen-l10n.md): The module that keeps the texts of the app in ARB files with gen-l10n of Flutter, a provider of the localization role. - [get_it](https://doc.saymyframe.com/modules/get-it.md): The module of dependency injection with get_it, which provides the DI role and registers the services of all modules. - [event_bus](https://doc.saymyframe.com/modules/event-bus.md): The module of events with the event_bus package, which provides the events role. - [shared_preferences](https://doc.saymyframe.com/modules/shared-preferences.md): The module that keeps the settings of the app (not secrets) with shared_preferences, a provider of the preferences role. - [dart_define](https://doc.saymyframe.com/modules/dart-define.md): The module that gives the app the values of its .env file through --dart-define-from-file of the flutter tool, a provider of the role of the values in .env. - [local_notifications](https://doc.saymyframe.com/modules/local-notifications.md): The module that shows the notifications of the app with flutter_local_notifications, now or at about a time to come, and tells the app of the taps on them, a provider of the notifications role. - [firebase_core](https://doc.saymyframe.com/modules/firebase-core.md): The module that sets up Firebase for each flavor of the app, checks the machine for the FlutterFire CLI, and configures the flavor dev after generation with a script of the app. - [firebase_crashlytics](https://doc.saymyframe.com/modules/firebase-crashlytics.md): The module that reports errors to Firebase Crashlytics, a provider of the crash reporting role. - [firebase_analytics](https://doc.saymyframe.com/modules/firebase-analytics.md): The module that records events and screen views in Firebase Analytics, a provider of the analytics role. - [firebase_messaging](https://doc.saymyframe.com/modules/firebase-messaging.md): The module that receives push messages with Firebase Cloud Messaging, gives the backend of the app the address of the device and tells the app of the taps on the messages, a provider of the push role. - [firebase_auth](https://doc.saymyframe.com/modules/firebase-auth.md): The module that signs the users of the app in with Firebase Authentication, with an email address and a password, as anonymous users, or with Google and Apple, a provider of the auth role. - [google_sign_in](https://doc.saymyframe.com/modules/google-sign-in.md): The module with which the users of the app sign in with their Google account on Android and iOS, a way to sign in that it gives the auth role. - [apple_sign_in](https://doc.saymyframe.com/modules/apple-sign-in.md): The module with which the users of the app sign in with their Apple Account on iOS, a way to sign in that it gives the auth role, with the capability Sign in with Apple of the iOS app. - [dio](https://doc.saymyframe.com/modules/dio.md): The module that sends the requests of the REST client of the app over a Dio, a provider of the REST role, with the place for an interceptor and what another adapter needs. - [revenuecat](https://doc.saymyframe.com/modules/revenuecat.md): The module that sells the premium access of the app with RevenueCat and purchases_flutter, restores it on another device and knows before the first frame whether the user has it, a provider of the purchases role. - [github_actions](https://doc.saymyframe.com/modules/github-actions.md): The module that writes the CI of the app into a workflow of GitHub Actions, a provider of the CI role, with the checks on each push and a release APK for one environment on request. ## Concepts - [The module model](https://doc.saymyframe.com/concepts/module-model.md): Modules, their kinds, roles and the modules that provide them, and how modules relate without knowing each other. - [Sockets and contributions](https://doc.saymyframe.com/concepts/sockets.md): What a module can add to an app, the sockets where modules put code into shared files, and in which order. - [Module independence](https://doc.saymyframe.com/concepts/independence.md): The principle SMF is built on, that modules do not know each other, and how the module model enforces it. - [The generation pipeline](https://doc.saymyframe.com/concepts/pipeline.md): The stages of smf create, from the selection of modules to the app in its directory, and the packages that implement them. - [How settings work](https://doc.saymyframe.com/concepts/settings.md): How a setting of a module is remembered between launches and shown on the settings screen without the module knowing the storage or the screen, and how the theme mode is built from the same roles. - [Texts and languages](https://doc.saymyframe.com/concepts/localization.md): How the modules of an app give their texts to the localization role, how the languages of the app are chosen, and what the role and its provider generate. - [Guards of routes](https://doc.saymyframe.com/concepts/guards.md): How a module keeps the user from the rest of the app, or from some of its routes, until a condition holds, in which order the app asks its guards, and where the user comes back to. - [Conditions of routes](https://doc.saymyframe.com/concepts/conditions.md): How a route asks for something that only some screens need, such as an account, how a guard stands for it, and what the user sees while it does not hold. ## Extending SMF - [Extending SMF](https://doc.saymyframe.com/extending.md): Write modules of your own for SMF, such as features, infrastructure, providers of roles and new roles, and generate apps with them. - [A module package](https://doc.saymyframe.com/extending/module-package.md): The layout of the package of a module, its pubspec, its bricks and how to bundle them. - [Write a feature module](https://doc.saymyframe.com/extending/feature-module.md): Build a feature module step by step, with a route, a tab, a service in the DI container and variants for BLoC and Riverpod, declare a guard, and ask for a condition on a route. - [Write an infrastructure module](https://doc.saymyframe.com/extending/infrastructure-module.md): Add start-up code, dependencies, native settings and README sections to an app, check the machine, run commands after generation and list the steps that only the developer can do. - [Add a setting](https://doc.saymyframe.com/extending/settings.md): Build a module with a setting that the app remembers between launches and shows on the settings screen, and that works in an app without preferences or a settings screen too. - [Add a step to the onboarding](https://doc.saymyframe.com/extending/onboarding-steps.md): Give the onboarding of the app a page of your module, such as one that asks for a permission, without knowing which module shows the onboarding. - [Texts](https://doc.saymyframe.com/extending/texts.md): Give the texts of a module to the localization role, read them in templates in the language of the app, and keep the module working in an app without the role. - [Provide a role](https://doc.saymyframe.com/extending/role-provider.md): Implement a role with a module, such as a state manager, a service for events, analytics or crash reporting, sign-in, a REST client, a DI container, a router, a layout, CI, an app icon or a splash screen. - [Ask the guards in a router](https://doc.saymyframe.com/extending/router-guards.md): What a module that provides the router role does in an app with guards of routes, from the two calls of GuardedNavigation and its answers to the request that waits, with go_router as the example. - [Provide the settings screen](https://doc.saymyframe.com/extending/provide-settings-screen.md): What a module that provides the settings screen role contributes, generates and promises, with the settings module as the example. - [Provide the localization](https://doc.saymyframe.com/extending/provide-localization.md): What a module that provides the localization role generates and promises, with gen_l10n as the example. - [Provide the theme](https://doc.saymyframe.com/extending/provide-theme.md): What a module that provides the theme role generates, and what it leaves to the role, with a minimal provider as the example. - [Provide sign-in](https://doc.saymyframe.com/extending/provide-auth.md): What a module that provides the auth role implements, what the role does itself with the session, the mode and the ways to sign in, and what every provider keeps to. - [Define a role](https://doc.saymyframe.com/extending/new-role.md): Define a new replaceable part of an app as a role, with its data, sockets, interface, template, options, modes, conditions for routes and rules. - [Templates](https://doc.saymyframe.com/extending/templates.md): The rules of the bricks of a module, covering variables, presence flags, variables that depend on a role, socket tags, variables and files of render hooks, imports and paths. - [Test a module](https://doc.saymyframe.com/extending/testing.md): Check a module with the contract harness of smf_pipeline and the rules of a module package, and test the code it generates. - [Rules for modules](https://doc.saymyframe.com/extending/rules.md): A checklist of the rules a module follows, most of which the pipeline and the contract harness check. - [Publish and use a module](https://doc.saymyframe.com/extending/publishing.md): Publish a module on pub.dev, generate apps with it through a command of your own, or propose it for SMF. ## Contributing - [Contributing](https://doc.saymyframe.com/contributing.md): How the repository of SMF is organized, how to run its checks, and the conventions of changes. ## API reference - [smf_contracts](https://pub.dev/documentation/smf_contracts/latest/) - [smf_pipeline](https://pub.dev/documentation/smf_pipeline/latest/) - [smf_flutter_cli](https://pub.dev/documentation/smf_flutter_cli/latest/)