https://github.com/defuncart/film_freund
An application to discover new films and organize what to watch next.
https://github.com/defuncart/film_freund
Last synced: 2 months ago
JSON representation
An application to discover new films and organize what to watch next.
- Host: GitHub
- URL: https://github.com/defuncart/film_freund
- Owner: defuncart
- Created: 2021-08-12T06:03:36.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-04T11:47:07.000Z (about 2 years ago)
- Last Synced: 2025-02-16T04:29:03.071Z (4 months ago)
- Language: Dart
- Size: 675 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# film_freund
[](https://codecov.io/gh/defuncart/film_freund)
An application to discover new films and organize what to watch next.
## Getting Started
To build the app locally, the following tools are required:
- Flutter stable >= 2.8
- Dart >= 2.15
- macOS:
- Xcode >= 13.0
- CocoaPods >= 1.11.0
- Web:
- Chrome
A Firebase project needs to be created and [integrated](https://firebase.google.com/docs/flutter/setup). Note that to speed up development build times, a [pre-compiled version of Firestore](https://github.com/invertase/firestore-ios-sdk-frameworks#supported-firebase-ios-sdk-versions) on iOS and macOS is used.
An [API key](https://developers.themoviedb.org/3/getting-started/introduction) is needed to query TMDB. Once a key is obtained, create the file `lib/services/movies/movie_database.secrets.dart` with the content:
```dart
part of 'movie_database.dart';
const apiKey = 'apiKey';
```
where apiKey is the TMDB v3 api key.
## Code Generation
### Localizations
To add new localizations, update `assets_dev/loca/loca.csv` and run
```sh
sh bin/loca_generate.sh
```
## Tests
A local code coverage report can be generated using
```sh
sh bin/test_local_coverage_report.sh
```
and viewed by opening `coverage/index.html`.
Golden tests are used to verify that widgets appear as they should. [alchemist](https://pub.dev/packages/alchemist) is used to ensure goldens can be generated platform agnostic and not be successible to discrepancies on CI pipeline.
## Credits
This application is developed for personal use, and is inspired by Letterbox, iMDb and Filmweb. This product uses the TMDB API but is not endorsed or certified by TMDB.
## Raising Issues and Contributing
Please report bugs and issues, and raise feature requests [here](https://github.com/defuncart/film_freund/issues).
To contribute, submit a PR with a detailed description and tests, if applicable.