YTS Mobile

A simple mobile client app for browsing movies listed under YTS website.

Content

• Get started

• App Architecture & Folder Structure

• Plugins and Packages used

• Previews

• How to contribute

Get Started

To get started, first clone or download the repository to your pc or laptop. Then run flutter pub get command in your terminal to download and cache all the dependencies. After that make sure to run flutter pub run build_runner build --delete-conflicting-outputs command to execute the code generator to generate necessary files related to freezed and json serialization. And you are good to go 🚀.

App Architecture and Folder Structure

The code of the app implements clean architecture to separate the UI, domain and data layers with a features-first approach for folder structure.

Folder Structure

lib
├── app
├── core
│   ├── animations
│   ├── app_state
│   ├── configs
│   ├── errors
│   ├── extensions
│   ├── models
│   ├── routes
│   ├── services
│   │   ├── http
│   │   └── storage
│   ├── theme
│   ├── utils
│   ├── widgets
│   │   └── loaders
├── features
│   ├── auth
│   │   ├── application
│   │   ├── infrastructure
│   │   │    ├── models
│   │   │    └── repositories
│   │   └── presentation
│   │       ├── pages
│   │       └── widgets
│   ├── movies
│   │   ├── application
│   │   ├── infrastructure
│   │   │    ├── models
│   │   │    └── repositories
│   │   └── presentation
│   │       ├── pages
│   │       └── widgets
├── firebase_options.dart
└── main.dart

• main.dart file has services initialization code and wraps the root YtsApp with a ProviderScope.

• firebase_options.dart is auto-generated file by flutterfire CLI which contains all the nessary configuration for firebase. integration.

• The app folder with yts_app has the root MaterialApp which injects the theme data and navigation data entire all the widget tree.

• The core folder contains code shared across features :

  • animations folder contains the code to animate the widgets.

  • app_state folder contains the model that represents the state of app during api call i.e initial, loading, loaded, success, error.

  • configs contains the configuration of app such as base_url for api call.

  • constants folder is where all the constant values used across the app such as app_assets with list of the path for assets are declared.

  • errors folder contains the model that parses exceptions and dio_error and returns failure object.

  • extensions folder contains all the extension methods such as snackbar_extension that shows snackbar when called like context.showSnackbar().

  • models folder contains the core models for pagination and caching the api response.

  • routes folders contains the list of route_paths and go_router navigation configurations.

  • services folder abstract app-level services with their implementations

    • http service is implemented with Dio and uses a CacheInterceptor to achieve caching by using the StorageService.
    • storage service is implemented with Hive * Service locator pattern and Riverpod are used to abstract services when used in other layers.

  • theme folder contain general styles (colors, themes & text styles)

  • utilsfolder contain the helper methods such as validators for forms.

  • widgets folder contains all the core-widgets that are rendered in similar state across the app, such as shimmer, error_view, buttons, text-fields, loading-indicators, etc.

• The features folder: the repository pattern is used to decouple logic required to access data sources from the domain layer.

  • application folder also known as domain layer that contains all the business logic of the particular feature for example latest_movie_provider controls the app state from loading to success or error based on API response and sends it back to UI where the listeners and builders renders the components based on data provided.
  • intrastructure folder also known as data layer: The repository pattern is used to decouple logic required to access data sources from the domain layer.
    • models folder contains all the data class model generated using Freezed with support for parsing json to dart object, copy-with method, and more.
    • repositories folder contains the abstract-class and it's implementation which interact with network calls parses data and sends back to domain layer.

• The presentation folder also known as presentation layer which contains all the UI components.

Authentication :

• firebase_auth: ^4.2.3
• google_sign_in: ^5.4.2
• flutter_facebook_login 3.0.0

Plugins and Packages used :

HTTPs & Connectivity :

• dio: ^4.0.6

State Management and Dependency Injection :

• flutter_riverpod: ^2.1.1

Navigation :

• go_router: ^6.0.0 -url_strategy: ^0.2.0

Firebase :

• firebase_core: ^2.4.0

Icons, Theme and animations :

• lottie: ^2.1.0
• flutter_vector_icons: ^2.0.0
• flutter_svg: ^1.1.6
• flex_color_scheme: ^6.1.1
• flutter_launcher_icons: ^0.11.0

Code generation and testing :

• dartz: ^0.10.1
• freezed_annotation: ^2.2.0
• freezed: ^2.2.0
• json_annotation: ^4.4.0
• json_serializable: ^6.1.4
• json_annotation: ^4.7.0
• build_runner: ^2.3.0
• hive_test: ^1.0.1
• http_mock_adapter: ^0.3.3
• mocktail: ^0.3.0
• mocktail_image_network: ^0.3.1
• equatable: ^2.0.5

Local storage :

• hive_flutter: ^1.1.0

Others utilities :

• url_launcher: ^6.1.7
• shimmer: ^2.0.0
• pull_to_refresh: ^2.0.0
• flutter_keyboard_visibility: ^5.4.0
• another_flushbar: ^1.12.29
• clock: ^1.1.1
• cached_network_image: ^3.2.3
• very_good_analysis: ^3.1.0

Previews

Light Mode	Dark Mode

How to contribute

🚧 This project is still under development phase 🚧

• If encountered any bugs feel free to report here
• If you want to contribute to the project you can send Pull request.