Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mo7amedaliEbaid authored Dec 15, 2023
1 parent 18fb91f commit b2a3ea8
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
# movies_riverpod

movies_riverpod is a versatile Flutter app designed for seamless movie exploration across different platforms. The app follows a Clean Architecture pattern, ensuring a modular and maintainable codebase. It has been successfully tested on mobile platforms (Android, iOS) and desktop (Linux).

## Directory Structure.

📁 **core:** Houses fundamental components essential for the application, such as the main app configuration (`app.dart`), error handling (`observers.dart`), extensions, constants, and other core functionalities.

https://github.com/mo7amedaliEbaid/movies_riverpod/assets/131966482/e6e4c60f-1ba1-43fd-8b2c-31aea4451299
📁 **di (Dependency Injection):** Manages the dependency injection logic for improved code organization and testability. The `injector.dart` file resides here.

📁 **features:** Organized into three subdirectories: `data` for data-related logic and repositories, `domain` for domain entities and use cases, and `presentation` for UI screens and widgets. This follows a clean architecture approach, promoting separation of concerns.

📁 **models:** Contains the data models used throughout the application, such as `movies.dart` and `casts.dart`.

📄 **main.dart:** The entry point of the application, where the execution begins. It imports and initializes necessary components to kickstart the Flutter app.


# movies_riverpod
https://github.com/mo7amedaliEbaid/movies_riverpod/assets/131966482/e6e4c60f-1ba1-43fd-8b2c-31aea4451299

movies_riverpod is a versatile Flutter app designed for seamless movie exploration across different platforms. The app follows a Clean Architecture pattern, ensuring a modular and maintainable codebase. It has been successfully tested on mobile platforms (Android, iOS) and desktop (Linux).

## Features

- **Clean Architecture:** The project adheres to Clean Architecture principles, promoting separation of concerns and maintainability.

- **Multiplatform Compatibility:** Enjoy a consistent experience on mobile (both portrait and landscape) and desktop (Linux).

- **State Management with Riverpod:** Leverage Riverpod for efficient and scalable state management.
Expand All @@ -36,6 +44,8 @@ https://github.com/mo7amedaliEbaid/movies_riverpod/assets/131966482/e6e4c60f-1ba

- **Now Showing Movies:** Stay updated on movies currently being screened.

- **Track Your Activity:** Utilize the "Notifications" feature to keep a record of your interactions within the app.

## Dependencies
The project utilizes a range of dependencies to enhance functionality and streamline development. Some key dependencies include:

Expand Down Expand Up @@ -110,6 +120,11 @@ Key development dependencies include:
<img src="https://github.com/mo7amedaliEbaid/movies_riverpod/blob/72d21e9e3abd2bce283c60d1291014a6a76b86e7/screenshots/desktop/desk5.png" width="670" />
</p>

### Getting Started
To get started with the project, follow these steps:

- Clone the repository.
- Install dependencies using flutter pub get.
- Run the app on your preferred platform using flutter run.


0 comments on commit b2a3ea8

Please sign in to comment.