https://github.com/kranfix/balance_flutter_app
Nubank Flutter Challenge
https://github.com/kranfix/balance_flutter_app
Last synced: about 1 year ago
JSON representation
Nubank Flutter Challenge
- Host: GitHub
- URL: https://github.com/kranfix/balance_flutter_app
- Owner: kranfix
- License: mit
- Created: 2021-12-09T22:36:44.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-15T07:45:44.000Z (over 4 years ago)
- Last Synced: 2025-03-23T16:05:44.050Z (about 1 year ago)
- Language: Dart
- Size: 76.2 KB
- Stars: 3
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nubank Flutter Challenge
![coverage][coverage_badge]
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
[![License: MIT][license_badge]][license_link]
---
## Getting Started 🚀
This project contains 3 flavors:
- development
- staging
- production
This application required the creation of some app config files:
- [lib/config/config_development.dart](lib/config/config_development.dart)
- [lib/config/config_staging.dart](lib/config/config_staging.dart)
- [lib/config/config_production.dart](lib/config/config_production.dart)
To create them, first run the followin command:
```bash
cd lib/config && bash config_generator.sh
```
And then edit the files to provide the envieronment variables (similar to flavors or schemes).
```dart
// ignore_for_file: lines_longer_than_80_chars
import 'package:nubank_flutter_challenge/config/config.dart';
const config = AppConfig(
serverUrl: 'SERVER_URL',
token: 'TOKEN',
);
```
> Ignore the last step if the environment variables are exported.
To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:
```sh
# Development
$ flutter run --flavor development --target lib/main_development.dart
# Staging
$ flutter run --flavor staging --target lib/main_staging.dart
# Production
$ flutter run --flavor production --target lib/main_production.dart
```
_\*Nubank Flutter Challenge works on iOS, Android, and Web._
---
## Running Tests 🧪
To run all unit and widget tests use the following command:
```sh
$ flutter test --coverage --test-randomize-ordering-seed random
```
To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov).
```sh
# 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 localizable string, open the `app_en.arb` file at `lib/l10n/arb/app_en.arb`.
```arb
{
"@@locale": "en",
"counterAppBarTitle": "Counter",
"@counterAppBarTitle": {
"description": "Text shown in the AppBar of the Counter Page"
}
}
```
2. Then add a new key/value and description
```arb
{
"@@locale": "en",
"counterAppBarTitle": "Counter",
"@counterAppBarTitle": {
"description": "Text shown in the AppBar of the Counter Page"
},
"helloWorld": "Hello World",
"@helloWorld": {
"description": "Hello World Text"
}
}
```
3. Use the new string
```dart
import 'package:nubank_flutter_challenge/l10n/l10n.dart';
@override
Widget build(BuildContext context) {
final l10n = context.l10n;
return Text(l10n.helloWorld);
}
```
### Adding Supported Locales
Update the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info.plist` to include the new locale.
```xml
...
CFBundleLocalizations
en
es
...
```
### Adding Translations
1. For each supported locale, add a new ARB file in `lib/l10n/arb`.
```
├── l10n
│ ├── arb
│ │ ├── app_en.arb
│ │ └── app_es.arb
```
2. Add the translated strings to each `.arb` file:
`app_en.arb`
```arb
{
"@@locale": "en",
"counterAppBarTitle": "Counter",
"@counterAppBarTitle": {
"description": "Text shown in the AppBar of the Counter Page"
}
}
```
`app_es.arb`
```arb
{
"@@locale": "es",
"counterAppBarTitle": "Contador",
"@counterAppBarTitle": {
"description": "Texto mostrado en la AppBar de la página del contador"
}
}
```
## Packages
This project is based on full tested packages.
- [domain][domain_pkg_link]: Define Entities and repositories.
- [graphql_repositories][graphql_repositories_pkg_link] Implements the repositories based on GraphQL.
[coverage_badge]: coverage_badge.svg
[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
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli
[domain_pkg_link]: packages/domain
[graphql_repositories_pkg_link]: packages/graphql_repositories