piihuynh / flutter_auth_app_tdd_clean

Flutter auth app with TDD Clean Architecture

Flutter App Auth 📱

This is an App with Auth Functions like Login and Register. All API using reqres.in.
This app also implementing Flutter Clean Architecture with TDD.

light-theme.mp4

dark-theme.mp4

Pre-requisites 📐

Technology	Recommended Version	Installation Guide
Flutter	v3.10.x	Flutter Official Docs
Dart	v3.0.x	Installed automatically with Flutter

Get Started 🚀

• Clone this project
• Run flutter pub get
• Run flutter gen-l10n to generate localization files
• Run flutter pub run build_runner build --delete-conflicting-outputs to generate freezes files
• Run flutter run --flavor stg -t lib/main.dart --dart-define-from-file .env.stg.json for staging or
• Run flutter run --flavor prd -t lib/main.dart --dart-define-from-file .env.prd.json for production
• Run Test flutter test
• To generate launcher icon based on Flavor dart pub run flutter_launcher_icons:main -f flutter_launcher_icons*
• To generate mock class dart pub run build_runner build

Feature ✅

• BLoC State Management
• Clean Architecture with TDD
  • Unit Test
  • Widget Test
  • BLoC test
• Theme Configuration: System, Light, Dark
• Multi-Language: English, Bahasa
• Login, Register Example
• Pagination Example
• Autofill Username and Password

TODO 📝

• Integration Test
• Implement multi-flavor
• Implement Go Router

Maestro Test 🧪

574ae4cc-e3a9-4755-8494-81bfe8763e00.mp4

Architecture Proposal by Resocoder

Project Structure

lib
├── config.dart
├── core
│   ├── api
│   │   ├── api.dart
│   │   ├── dio_client.dart
│   │   ├── dio_interceptor.dart
│   │   ├── isolate_parser.dart
│   │   └── list_api.dart
│   ├── app_route.dart
│   ├── core.dart
│   ├── core_mapper.dart
│   ├── error
│   │   ├── error.dart
│   │   ├── exceptions.dart
│   │   └── failure.dart
│   ├── localization
│   │   ├── generated
│   │   │   ├── strings.dart
│   │   │   ├── strings_en.dart
│   │   │   └── strings_id.dart
│   │   ├── intl_en.arb
│   │   ├── intl_id.arb
│   │   ├── l10n.dart
│   │   └── localization.dart
│   ├── resources
│   │   ├── dimens.dart
│   │   ├── images.dart
│   │   ├── palette.dart
│   │   ├── resources.dart
│   │   └── styles.dart
│   ├── usecase
│   │   └── usecase.dart
│   └── widgets
│       ├── button.dart
│       ├── button_notification.dart
│       ├── button_text.dart
│       ├── circle_image.dart
│       ├── color_loaders.dart
│       ├── drop_down.dart
│       ├── empty.dart
│       ├── loading.dart
│       ├── my_appbar.dart
│       ├── parent.dart
│       ├── spacer_h.dart
│       ├── spacer_v.dart
│       ├── text_f.dart
│       ├── toast.dart
│       └── widgets.dart
├── dependencies_injection.dart
├── features
│   ├── auth
│   │   ├── auth.dart
│   │   ├── data
│   │   │   ├── data.dart
│   │   │   ├── datasources
│   │   │   │   ├── auth_remote_datasources.dart
│   │   │   │   └── datasources.dart
│   │   │   ├── models
│   │   │   │   ├── login_response.dart
│   │   │   │   ├── login_response.freezed.dart
│   │   │   │   ├── login_response.g.dart
│   │   │   │   ├── models.dart
│   │   │   │   ├── register_response.dart
│   │   │   │   ├── register_response.freezed.dart
│   │   │   │   └── register_response.g.dart
│   │   │   └── repositories
│   │   │       ├── auth_repository_impl.dart
│   │   │       └── repositories.dart
│   │   ├── domain
│   │   │   ├── domain.dart
│   │   │   ├── entities
│   │   │   │   ├── entities.dart
│   │   │   │   ├── login.dart
│   │   │   │   ├── login.freezed.dart
│   │   │   │   ├── register.dart
│   │   │   │   └── register.freezed.dart
│   │   │   ├── repositories
│   │   │   │   ├── auth_repository.dart
│   │   │   │   └── repositories.dart
│   │   │   └── usecases
│   │   │       ├── post_login.dart
│   │   │       ├── post_login.freezed.dart
│   │   │       ├── post_login.g.dart
│   │   │       ├── post_register.dart
│   │   │       ├── post_register.freezed.dart
│   │   │       ├── post_register.g.dart
│   │   │       └── usecases.dart
│   │   └── pages
│   │       ├── login
│   │       │   ├── cubit
│   │       │   │   ├── auth_cubit.dart
│   │       │   │   ├── auth_cubit.freezed.dart
│   │       │   │   ├── auth_state.dart
│   │       │   │   └── cubit.dart
│   │       │   ├── login.dart
│   │       │   └── login_page.dart
│   │       ├── pages.dart
│   │       └── register
│   │           ├── cubit
│   │           │   ├── cubit.dart
│   │           │   ├── register_cubit.dart
│   │           │   ├── register_cubit.freezed.dart
│   │           │   └── register_state.dart
│   │           ├── register.dart
│   │           └── register_page.dart
│   ├── features.dart
│   ├── general
│   │   ├── general.dart
│   │   └── pages
│   │       ├── main
│   │       │   ├── main.dart
│   │       │   ├── main_page.dart
│   │       │   └── menu_drawer.dart
│   │       ├── pages.dart
│   │       ├── settings
│   │       │   ├── cubit
│   │       │   │   ├── cubit.dart
│   │       │   │   └── settings_cubit.dart
│   │       │   ├── settings.dart
│   │       │   └── settings_page.dart
│   │       └── splashscreen
│   │           ├── splash_screen_page.dart
│   │           └── splashscreen.dart
│   └── users
│       ├── data
│       │   ├── data.dart
│       │   ├── datasources
│       │   │   ├── datasources.dart
│       │   │   └── user_remote_datasources.dart
│       │   ├── models
│       │   │   ├── models.dart
│       │   │   ├── users_response.dart
│       │   │   ├── users_response.freezed.dart
│       │   │   └── users_response.g.dart
│       │   └── repositories
│       │       ├── repositories.dart
│       │       └── users_repository_impl.dart
│       ├── domain
│       │   ├── domain.dart
│       │   ├── entities
│       │   │   ├── entities.dart
│       │   │   ├── users.dart
│       │   │   └── users.freezed.dart
│       │   ├── repositories
│       │   │   ├── repositories.dart
│       │   │   └── users_repository.dart
│       │   └── usecases
│       │       ├── get_users.dart
│       │       ├── get_users.freezed.dart
│       │       ├── get_users.g.dart
│       │       └── usecases.dart
│       ├── pages
│       │   ├── dashboard
│       │   │   ├── cubit
│       │   │   │   ├── cubit.dart
│       │   │   │   ├── users_cubit.dart
│       │   │   │   ├── users_cubit.freezed.dart
│       │   │   │   └── users_state.dart
│       │   │   ├── dashboard.dart
│       │   │   └── dashboard_page.dart
│       │   └── pages.dart
│       └── users.dart
├── lzyct_app.dart
├── main_prd.dart
├── main_stg.dart
└── utils
    ├── ext
    │   ├── context.dart
    │   ├── ext.dart
    │   ├── string.dart
    │   └── text_theme.dart
    ├── helper
    │   ├── common.dart
    │   ├── constant.dart
    │   ├── data_helper.dart
    │   ├── data_helper.freezed.dart
    │   ├── go_router_refresh_stream.dart
    │   └── helper.dart
    ├── services
    │   ├── firebase
    │   │   ├── firebase.dart
    │   │   ├── firebase_crashlogger.dart
    │   │   └── firebase_services.dart
    │   ├── hive
    │   │   ├── hive.dart
    │   │   └── main_box.dart
    │   └── services.dart
    └── utils.dart

Test Project Structure

test
├── features
│   ├── auth
│   │   ├── data
│   │   │   ├── datasources
│   │   │   │   ├── models
│   │   │   │   │   ├── login_response_test.dart
│   │   │   │   │   └── register_response_test.dart
│   │   │   │   └── repositories
│   │   │   │       └── auth_remote_datasources_test.dart
│   │   │   └── repositories
│   │   │       └── auth_repository_impl_test.dart
│   │   ├── domain
│   │   │   └── usecases
│   │   │       ├── post_login_test.dart
│   │   │       └── post_register_test.dart
│   │   └── pages
│   │       ├── login
│   │       │   ├── cubit
│   │       │   │   ├── auth_cubit_test.dart
│   │       │   │   ├── auth_cubit_test.mocks.dart
│   │       │   │   └── auth_state_test.dart
│   │       │   └── login_page_test.dart
│   │       └── register
│   │           ├── cubit
│   │           │   ├── register_cubit_test.dart
│   │           │   ├── register_cubit_test.mocks.dart
│   │           │   └── register_state_test.dart
│   │           └── register_page_test.dart
│   ├── general
│   │   └── pages
│   │       └── settings
│   │           ├── cubit
│   │           │   └── settings_cubit_test.dart
│   │           └── settings_page_test.dart
│   └── users
│       ├── data
│       │   ├── datasources
│       │   │   ├── models
│       │   │   │   └── users_response_test.dart
│       │   │   └── repositories
│       │   │       └── users_remote_datasources_test.dart
│       │   └── repositories
│       │       └── users_repository_impl_test.dart
│       ├── domain
│       │   └── usecases
│       │       └── get_users_test.dart
│       └── pages
│           └── dashboard
│               ├── cubit
│               │   ├── users_cubit_test.dart
│               │   ├── users_cubit_test.mocks.dart
│               │   └── users_state_test.dart
│               └── dashboard_page_test.dart
└── helpers
    ├── fake_path_provider_platform.dart
    ├── json_reader.dart
    ├── paths.dart
    ├── stubs
    │   ├── list_user_empty_response.json
    │   ├── list_user_response.json
    │   ├── login_success_response.json
    │   ├── login_unsuccessful_response.json
    │   ├── register_success_response.json
    │   └── register_unsuccessful_response.json
    ├── test_mock.dart
    └── test_mock.mocks.dart

Buy me coffee if you love my works ☕️