Watch And Earn docs
 v3.0.0
Live demoConsole demo Get help
● Set up · Backend

Firebase setup
your own project.

Create the project, deploy the rules, indexes and Cloud Functions, connect the app and switch on App Check. The full reference is firebase/README.md in the package.

Blaze planNode 22Cloud Functions 2nd gen

01Create the project

  1. Create a Firebase projectIn the Firebase console, add a project. Remember its project id.
  2. Upgrade to BlazeCloud Functions, Cloud Scheduler and calls to the ad networks and stores only work on the Blaze (pay-as-you-go) plan. Set a budget alert in Google Cloud Billing. Required
  3. Enable AuthenticationBuild → Authentication → Sign-in method. Enable Anonymous (the "Continue as guest" button), Google and Apple. The app signs in with these three and lets a guest link Google or Apple later (app/lib/data/firebase_backend.dart).
  4. Create FirestoreBuild → Firestore Database, Native mode. Pick a location close to your users.
Google and Apple sign-in need platform setup too

Firebase's own guides describe it: for Google on Android add your app's SHA-1 and SHA-256 fingerprints in Project settings; for Apple add the Sign in with Apple capability in Xcode and configure it in your Apple developer account. The package ships no iOS entitlements file, so Xcode creates one when you add the capability.

02Point the backend at your project

firebase/.firebaserc ships with demo-watchandearn, an emulator-only id. Replace it with yours:

cd firebase
firebase login
firebase use --add   # pick your project; or edit .firebaserc by hand

03Choose the Functions region

Functions deploy to us-central1 by default (firebase/functions/src/index.ts). To use another region, create firebase/functions/.env from the example and set it:

cd firebase/functions
cp .env.example .env   # then edit FUNCTIONS_REGION, e.g. europe-west1
Variable in firebase/functions/.envDefaultPurpose
FUNCTIONS_REGIONus-central1Region of every function.
ENFORCE_APP_CHECKtrueApp Check on every callable. Set false only while you wire App Check up.

If you change the region, use the same one in three places: the app build (--dart-define=FUNCTIONS_REGION=…, see Build switches), the console's Backend → Cloud Functions base URL, and every callback URL you give to ad networks and partners.

This file holds no secrets. Ad network secrets and store keys are entered in the console and stored in the Firestore document config/private, which no app can read.

04Deploy rules, indexes and functions

cd firebase/functions && npm ci && cd ..
firebase deploy --only firestore:rules,firestore:indexes,functions

The deploy builds the TypeScript first (predeploy in firebase/firebase.json). At the end it prints the URLs of the HTTP functions (ssvAdmob, ssvApplovin, ssvUnity, ssvIronsource, offerPostback); you also find them in Firebase console → Functions. Building the indexes can take a few minutes.

The deploy also creates the hourly job expireAdSessions (Cloud Scheduler), which marks unused ad sessions as expired.

Settings come from the console

Until the operator console has run once, the Functions use the defaults from docs/CONTRACT.md. The console writes config/public and config/private on start and on every save.

05Connect the app (flutterfire configure)

app/lib/firebase_options.dart is a placeholder with empty values. While it is empty the app shows a setup screen. Replace it:

dart pub global activate flutterfire_cli
cd app
flutterfire configure   # choose your project and the android, ios and web platforms

Run it again after you change the application id or bundle id (see Rebranding), so the Firebase apps match the new ids.

06App Check

Every callable function refuses calls without a valid App Check token in production (firebase/functions/src/guard.ts). The app activates App Check on Android and iOS (app/lib/core/firebase_setup.dart): Play Integrity on Android, App Attest with DeviceCheck fallback on iOS, and the debug provider in debug builds.

  1. Register the appsFirebase console → App Check → Apps. Register the Android app with Play Integrity and the iOS app with App Attest (and DeviceCheck).
  2. Add debug tokens for developmentA debug build prints a debug token in the device log the first time it starts. Add it in Firebase console → App Check → Apps → your app → Manage debug tokens. Without it a debug build gets permission-denied or unauthenticated errors.
  3. Enforce for FirestoreApp Check → APIs → Cloud Firestore → Enforce.
  4. While wiring upYou may set ENFORCE_APP_CHECK=false in firebase/functions/.env and redeploy. Turn it back to true before release. The emulator never enforces App Check.
Play Integrity needs the store-signed app

Play Integrity tokens are valid for the app as distributed by Google Play. Add your upload and app signing certificate fingerprints in Firebase Project settings, and test release behaviour with an internal-testing build from Play Console.

07Indexes and rules

firebase/firestore.indexes.json holds the composite indexes (ad-session expiry, open fraud flags) and the collection-group overrides the console and account deletion need (ledger.createdAt descending, daily.day, leaderboard entries.points and entries.uid). firebase/firestore.rules lets a user read only their own data and change only their displayName and settings; points, ledger, streaks and leaderboards are written only by the server.

08Check it worked

  • Firebase console → Functions lists ensureProfile, requestAdSession, ssvAdmob and the other functions in your region
  • Firestore → Indexes shows every index as Enabled
  • After the console started once, Firestore has config/public and config/private
  • The app starts past the setup screen and "Continue as guest" works