Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bizz84/tmdb_movie_app_riverpod
Flutter Movies app with Riverpod (TMDB API)
https://github.com/bizz84/tmdb_movie_app_riverpod
flutter
Last synced: 5 days ago
JSON representation
Flutter Movies app with Riverpod (TMDB API)
- Host: GitHub
- URL: https://github.com/bizz84/tmdb_movie_app_riverpod
- Owner: bizz84
- License: mit
- Created: 2022-09-12T08:28:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T13:57:47.000Z (8 months ago)
- Last Synced: 2024-12-24T06:13:50.348Z (13 days ago)
- Topics: flutter
- Language: Dart
- Homepage: https://codewithandrea.com/
- Size: 543 KB
- Stars: 251
- Watchers: 3
- Forks: 44
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Flutter Movies app with Riverpod (TMDB API)
This is an improved version of my [old movies app](https://github.com/bizz84/movie_app_state_management_flutter) based on the latest Riverpod 2.0 APIs.
## Motivation
I built this app to showcase the **latest APIs** for popular packages such as Riverpod and GoRouter.
This is not meant to be a complete movies app, yet it should implement common use cases and features. 👇
## Current Features
- Infinite scrolling with pagination
- Pull to refresh
- Search functionality
- Loading UI with the [Shimmer](https://pub.dev/packages/shimmer) package
- Stateful nested routing with [`StatefulShellRoute`](https://pub.dev/documentation/go_router/latest/go_router/StatefulShellRoute-class.html)
Here's a detailed tutorial explaining how the pagination and search UI works:
- [Flutter Pagination with Riverpod: The Ultimate Guide](https://codewithandrea.com/articles/flutter-riverpod-pagination/)
## Planned Features (no promises 😅)
- Favourites
- Responsive UI
## Packages in use
- [flutter_riverpod](https://pub.dev/packages/riverpod) and [riverpod_generator](https://pub.dev/packages/riverpod_generator) for data caching (and much more!)
- [freezed](https://pub.dev/packages/freezed) for JSON serialization
- [dio](https://pub.dev/packages/dio) for networking
- [go_router](https://pub.dev/packages/go_router) for navigation
- [shimmer](https://pub.dev/packages/shimmer) for the loading UI
- [envied](https://pub.dev/packages/envied) for handling API keys
- [cached_network_image](https://pub.dev/packages/cached_network_image) for caching images
## App Architecture & Folder structure
The project follows my Riverpod app architecture with a feature-first project structure.
More details here:
- [Flutter App Architecture with Riverpod: An Introduction](https://codewithandrea.com/articles/flutter-app-architecture-riverpod-introduction/)
- [Flutter Project Structure: Feature-first or Layer-first?](https://codewithandrea.com/articles/flutter-project-structure/)
It also uses the new [Riverpod Generator](https://pub.dev/packages/riverpod_generator) package, which I have covered here:
- [How to Auto-Generate your Providers with Flutter Riverpod Generator](https://codewithandrea.com/articles/flutter-riverpod-generator/)
## Getting a TMDB API Key and Running the Project
This project uses the TMDB API to get the latest movies data.
Before running the app, you need to [sign up on the TMDB website](https://www.themoviedb.org/signup), then obtain an API key on the [settings API page](https://www.themoviedb.org/settings/api).
Once you have this, create an `.env` file **at the root of the project** and add your key:
```dart
// .env
TMDB_KEY=your-api-key
```
Then, run the code generator:
```
dart run build_runner build -d
```
This will generate a `env.g.dart` file inside `lib/env`. This contains the `tmdbApiKey` that is used when making requests to the TMDB API.
Congratulations, you're good to go. 😎
## Note: Loading images from insecure HTTP endpoints
The data returned by the TMBD API points to image URLs using http rather than https. For the images to load correctly, the following changes have been made:
### Android
Created a file at `android/app/src/main/res/xml/network_security_config.xml` with these contents:
```
```
Added this to the application tag in the `AndroidManifest.xml`:
```
android:networkSecurityConfig="@xml/network_security_config"
```
### iOS
Add the following to `ios/Runner/info.pList`:
```
NSAppTransportSecurity
NSAllowsArbitraryLoads
```
More information here:
- [Insecure HTTP connections are disabled by default on iOS and Android.](https://flutter.dev/docs/release/breaking-changes/network-policy-ios-android)
### macOS
Since macOS applications are sandboxed by default, we get a `SocketException` if we haven't added the required entitlements. This has been fixes by adding these lines to `macos/Runner/DebugProfile.entitlements` and `macos/Runner/Release.entitlements`:
```
com.apple.security.network.client
```
More info here:
- [How to fix "SocketException: Connection failed (Operation not permitted)" with Flutter on macOS](https://codewithandrea.com/tips/socket-exception-connection-failed-macos/)
## [LICENSE: MIT](LICENSE.md)