# last_fm
[](https://github.com/Elias8/last_fm/actions/workflows/workflow.yml)
[![codecov][coverage_link]](https://codecov.io/gh/Elias8/last_fm)
[](https://flutter.dev/docs/development/tools/sdk/releases)
[](https://opensource.org/licenses/MIT)
A simple app to demonstrate a testable, maintainable, and scalable architecture for flutter. flutter_bloc, hive, and
REST API are some of the tech stacks used in this project.
---
## ScreenShots ๐ท
 | 
---------------------------------------------|--------------------------------------------------
 | 
## Getting Started ๐
For the app to work, you need to provide your own [last.fm][lastfm_link] API key by issuing [here][lastfm_auth_link].
Once you get your API key, you can run or build the app by using the following command:
```shell
# Run
$ flutter run --dart-define=API_KEY=PUT_YOUR_API_KEY_HERE
# Build
$ flutter build --dart-define=API_KEY=PUT_YOUR_API_KEY_HERE
```
---
## Running Tests ๐งช
To run all unit and widget tests use the following command:
```shell
$ flutter test --coverage --test-randomize-ordering-seed random
```
To remove generated files from the coverage report, use the following command:
```shell
# install remove_from_coverage package
$ pub global activate remove_from_coverage
# remove `.g.dart` and `.config.dart` files from the coverage report
$ pub global run remove_from_coverage:remove_from_coverage -f coverage/lcov.info -r '.g.dart', '.config.dart'
```
To view the generated coverage report you can use [lcov][lcov_link].
```shell
# Generate Coverage Report
$ genhtml coverage/lcov.info -o coverage/
# Open Coverage Report
$ open coverage/index.html
```
---
## Working with Translations ๐
This project relies on [flutter_localizations][flutter_localizations_link] and follows
the [official internationalization guide for Flutter][internationalization_link].
### Adding Strings
1. To add a new localized string, open the `app_en.arb` file at `lib/config/l10n/arb/app_en.arb`.
```arb
{
"@@locale": "en",
"appName": "LastFM",
"@appName": {
"description": "The application name"
}
}
```
2. Then add a new key/value and description
```arb
{
"@@locale": "en",
"appName": "LastFM",
"@appName": {
"description": "The application name"
},
"albums": "Albums",
"@albums": {
"description": "Text shown in the AppBar of AlbumsScreen"
},
}
```
3. Use the new string
```dart
import 'package:some_app/l10n/l10n.dart';
@override
Widget build(BuildContext context) {
final l10n = context.l10n;
return Text(l10n.albums);
}
```
### Adding Supported Locales
Update the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info.plist` to include the new locale.
```xml
...
CFBundleLocalizations
en
am
...
```
### Adding Translations
1. For each supported locale, add a new ARB file in `lib/config/l10n/arb`.
```
โโโ l10n
โ โโโ arb
โ โ โโโ app_en.arb
โ โ โโโ app_am.arb
```
2. Add the translated strings to each `.arb` file:
`app_en.arb`
```arb
{
"@@locale": "en",
"appName": "LastFM",
"@appName": {
"description": "The application name"
},
}
```
`app_am.arb`
```arb
{
"@@locale": "am",
"appName": "แจแแจแจแป แคแ แคแ",
"@appName": {
"description": "แจแแฐแแ แชแซ แตแ"
},
}
```
## Credit ๐
Thanks to all the people who created and are maintaining these awesome packages used in this project.
Maintainers | Packages
-------------------------------------------------|-------------------------------------------
[Felix Angelov](https://github.com/felangel) | [bloc & flutter_bloc][bloc_link], [equatable][equatable_link], [mocktail][mocktail_link]
[Thomas Burkhart](https://github.com/escamoteur) | [get_it][get_it_link]
[Milad akarie](https://github.com/Milad-Akarie) | [injectable][injectable_link]
[Chris Sells](https://github.com/csells) | [go_router][go_router_link]
[Very Good Ventures][vgv_link] | For their awesome README [template][very_good_cli_link]
And everyone else | [dio][dio_link], [hive][hive_link], and many more...
## Features and bugs
You can file features requests (not intending to add new features, but I will try to add based on requests), bugs or any
questions at the [issue tracker][issue_tracker_link].
And don't forget to give a star if you find this repo helpful, or
you have learned something from it!
### Maintainers
* [Elias Andualem](https://github.com/elias8)
[flutter_localizations_link]: https://api.flutter.dev/flutter/flutter_localizations/flutter_localizations-library.html
[internationalization_link]: https://flutter.dev/docs/development/accessibility-and-localization/internationalization
[coverage_link]: https://codecov.io/gh/Elias8/last_fm/branch/main/graph/badge.svg?token=H09CZDS7P0
[lastfm_link]: https://www.last.fm
[lastfm_auth_link]: https://www.last.fm/api/authentication
[lcov_link]: https://github.com/linux-test-project/lcov
[issue_tracker_link]: https://github.com/Elias8/last_fm/issues
[comment]: <> (Packages)
[vgv_link]: https://github.com/VeryGoodOpenSource
[bloc_link]: https://github.com/felangel/bloc
[equatable_link]: https://github.com/felangel/equatable
[mocktail_link]: https://github.com/felangel/mocktail
[get_it_link]: https://github.com/fluttercommunity/get_it
[injectable_link]: https://github.com/Milad-Akarie/injectable
[go_router_link]: https://github.com/csells/go_router
[very_good_cli_link]: https://github.com/verygoodopensource/very_good_cli
[dio_link]: https://github.com/flutterchina/dio
[hive_link]: https://github.com/hivedb/hive