Skip to content

Latest commit

 

History

History
162 lines (105 loc) · 5.46 KB

README.md

File metadata and controls

162 lines (105 loc) · 5.46 KB
Raw

Book My Movie Flutter Project

Overview of Project

book_my_movie is a Flutter project designed to provide a seamless movie browsing and booking experience. The project follows the Clean Architecture pattern and utilizes Flutter Cubit for state management. Dependency injection is handled using GetIt. Below is the documentation outlining the project structure, dependencies, and other important details.

Documentation

Requirements

Environment

iOS

  • iOS 11+

Android

  • Android 5.1+
    • minSdkVersion 21
  • targetSdkVersion 30

App architecture

  • This design pattern helps to separate presentation from business logic. Following the BLoC pattern facilitates testability and reusability. This package abstracts reactive aspects of the pattern allowing developers to focus on writing the business logic.

Cubit

The goal of this library is to make it easy to separate presentation from business logic, facilitating testability and reusability.

  • A Cubit is class which extends BlocBase and can be extended to manage any type of state. Cubit requires an initial state which will be the state before emit has been called. The current state of a cubit can be accessed via the state getter and the state of the cubit can be updated by calling emit with a new state.

Dependency Injection

  • In Flutter, the default way to provide object/services to widgets is through InheritedWidgets. If you want a widget or it’s model to have access to a service, the widget has to be a child of the inherited widget. This causes unnecessary nesting.
  • That’s where get it comes in. An IoC that allows you to register your class types and request it from anywhere you have access to the container..

_You don’t need to wrap any widgets to inherit anything, or need the context anywhere. All you do is import the service_locator file and use the locator to resolve your type. This means that in places without the context you’ll still be able to inject the correct services and values, even if the app’s UI structure changes.

Project Structure

lib/
|-- core/
|   |-- domain/
|   |-- data/
|   |-- presentation/
|
|-- features/
|   |-- home/
|   |   |-- presentation/
|   |   |-- domain/
|   |   |-- data/
|   |
|   |-- movie_details/
|   |   |-- presentation/
|   |   |-- domain/
|   |   |-- data/
|
|-- common/
|   |-- constants/
|   |-- widgets/
|
|-- injection/
|-- main.dart

  • core: Contains the core logic of the application, following Clean Architecture principles.

    • domain: Defines entities, use cases, and repositories.
    • data: Implements data sources, repositories, and mappers.
    • presentation: Manages the UI, presentation logic, and state using Cubit.

  • features: Contains feature-specific modules.

    • home: Module for displaying the home screen with movie listings.
    • movie_details: Module for displaying detailed information about a selected movie.

  • common: Contains shared components and constants used across the application.

    • constants: Holds constant values used throughout the app.
    • widgets: Custom widgets used in different parts of the application.

  • injection: Handles dependency injection using GetIt.

  • main.dart: Entry point of the application.

Code Style

Assets, Fonts

If added some assets or fonts

Models

If added some models for api results

Getting Started

Setup

$ git branch -m main develop
$ git fetch origin
$ git branch -u origin/develop develop
$ git remote set-head origin -a

How to add assets(images..)

  1. Add assets
  2. Run FlutterGen

Screenshot