Flutter Riverpod Firebase

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

*Flutter Riverpod Firebase works on iOS, Android, Web, and Windows.

Structure 🏗

The project is structured as follows:

├── lib
│   ├── src
│   │   ├── app
│   │   │   ├── app.dart
│   │   ├── configs
│   │   │   ├── server.dart
│   │   ├── data
│   │   │   ├── datasources
│   │   │   │   ├── remote
│   │   │   │   │   ├── auth_data_remote.dart
│   │   │   │   │   ├── user_data_remote.dart
│   │   │   │   ├── local
│   │   │   │   │   ├── auth_data_local.dart
│   │   │   │   │   ├── todo_data_local.dart
│   │   │   │   │   ├── user_data_local.dart
│   │   │   ├── entites
│   │   │   │   ├── todo.dart
│   │   │   ├── repositories
│   │   │   │   ├── auth_repository.dart
│   │   │   │   ├── auth_repository_impl.dart
│   │   ├── di
│   │   │   ├── modules
│   │   │   │   ├── auth_module.dart
│   │   │   │   ├── routes_module.dart
│   │   │   │   ├── storage_module.dart
│   │   │   ├── injection.config.dart
│   │   │   ├── injection.dart
│   │   ├── features
│   │   │   ├── auth
│   │   │   │   ├── view
│   │   │   │   │   ├── login_form.dart
│   │   │   │   │   ├── login_page.dart
│   │   │   │   ├── view_model
│   │   │   │   │   ├── auth_riverpod.dart
│   │   │   │   ├── auth.dart
│   │   │   ├── todo
│   │   │   │   ├── view
│   │   │   │   │   ├── todo_page.dart
│   │   │   │   ├── view_model
│   │   │   │   │   ├── todo_riverpod.dart
│   │   │   │   ├── todo.dart
│   │   │   ├── feature.dart
│   │   ├── l10n
│   │   │   ├── arb
│   │   │   │   ├── app_en.arb
│   │   │   │   ├── app_ja.arb
│   │   │   ├── l10n.dart
│   │   │   ├── l10n_model.dart
│   │   ├── routes
│   │   │   ├── app_router.dart
│   │   │   ├── guards.dart
│   │   ├── shared
│   │   │   ├── extensions
│   │   │   ├── listeners
│   │   │   ├── resources
│   │   │   ├── storage
│   │   │   ├── theme
│   │   │   ├── widgets
│   │   │   ├── utils
│   ├── firebase_options.dart
│   ├── main.dart
│   ├── main_development.dart
│   ├── main_staging.dart
│   └── main_production.dart

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 at lib/src/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:flutter_riverpod_firebase/l10n/src/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/src/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"
    }
}

Generating Translations

To use the latest translations changes, you will need to generate them:

Generate localizations for the current project:

flutter gen-l10n --arb-dir="lib/src/l10n/arb"

Alternatively, run flutter run and code generation will take place automatically.

oengmengthong/flutter_riverpod_firebase