{"id":16402878,"url":"https://github.com/wisnuwiry/flutter-starter","last_synced_at":"2025-03-23T05:31:14.547Z","repository":{"id":52058020,"uuid":"358880564","full_name":"wisnuwiry/flutter-starter","owner":"wisnuwiry","description":"A boilerplate project was created in flutter using Clean Architecture \u0026 TDD.","archived":false,"fork":false,"pushed_at":"2022-08-10T04:01:05.000Z","size":3639,"stargazers_count":29,"open_issues_count":0,"forks_count":11,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-01T22:26:55.640Z","etag":null,"topics":["boilerplate","boilerplate-template","clean-architecture","clean-code","dart","dependency-injection","dio","flutter","flutter-bloc","injector","state-management"],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wisnuwiry.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null},"funding":{"github":["wisnuwiry"],"patreon":null,"open_collective":null,"ko_fi":"wisnuwiry","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"https://trakteer.id/wisnuwiry"}},"created_at":"2021-04-17T13:04:09.000Z","updated_at":"2025-02-21T11:39:20.000Z","dependencies_parsed_at":"2022-09-06T07:41:26.751Z","dependency_job_id":null,"html_url":"https://github.com/wisnuwiry/flutter-starter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wisnuwiry%2Fflutter-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wisnuwiry%2Fflutter-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wisnuwiry%2Fflutter-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wisnuwiry%2Fflutter-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wisnuwiry","download_url":"https://codeload.github.com/wisnuwiry/flutter-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244277050,"owners_count":20427309,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","boilerplate-template","clean-architecture","clean-code","dart","dependency-injection","dio","flutter","flutter-bloc","injector","state-management"],"created_at":"2024-10-11T05:47:31.547Z","updated_at":"2025-03-23T05:31:13.156Z","avatar_url":"https://github.com/wisnuwiry.png","language":"Dart","readme":"# Flutter Starter\n\n[![Wisnuwiry][logo]][website_link]\n\n[![Language][dart_language_badge]](http://dart.dev)\n[![Flutter Starter][github_action_badge]][github_action_workflow_link]\n[![Codecov][codecov_badge]][codecov_link]\n[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]\n[![License: MIT][license_badge]][license_link]\n[![PRs Welcome][pr_welcome_badge]][repo_link]\n[![Stars][stars_badge]][repo_link]\n[![Stars][issues_badge]][repo_link]\n[![Stars][pull_request_badge]][repo_link]\n\nA Flutter Starter Project created by the [Wisnu G. Saputra][website_link].\n\n---\n\n## Preview 🪟\n\n| Android     | iOS         | Web         |\n| ----------- | ----------- | ----------- |\n| ![Android][android_preview] | ![iOS][ios_preview]  | ![Web][web_preview] |\n\n\n## Getting Started 🚀\n\nThis project contains 3 flavors:\n\n- development\n- staging\n- production\n\n\nFor the first step you need to set the environment variable first. Copy the `assets/.env.example` file to `assets/.env` then fill in all the required fields. To preview the environment variables like this:\n\n```\nBASE_URL_PROD = \nBASE_URL_STG  = \nBASE_URL_DEV  = \n```\n\nTo run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:\n\n```sh\n# Development\n$ flutter run --flavor development --target lib/main_development.dart\n\n# Staging\n$ flutter run --flavor staging --target lib/main_staging.dart\n\n# Production\n$ flutter run --flavor production --target lib/main_production.dart\n```\n\n_\\*Flutter Starter works on iOS, Android, and Web._\n\n---\n\n## Build App 🔥\n\nTo build APK desired flavor use the following commands:\n\n```sh\n# Development\n$ flutter build apk --flavor development --target lib/main_development.dart\n\n# Staging\n$ flutter build apk --flavor staging --target lib/main_staging.dart\n\n# Production\n$ flutter build apk --flavor production --target lib/main_production.dart\n\n```\n\nAnd for builds for release, see the documentation according to the [Android](https://docs.flutter.dev/deployment/android) and [iOS](https://docs.flutter.dev/deployment/ios) platforms.\n\n---\n\n## Running Tests 🧪\n\nTo run all unit and widget tests use the following command:\n\n```sh\n$ flutter test --coverage --test-randomize-ordering-seed random\n```\n\nTo view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov).\n\n```sh\n# Generate Coverage Report\n$ genhtml coverage/lcov.info -o coverage/\n\n# Open Coverage Report\n$ open coverage/index.html\n```\n\n---\n\n## Working with Translations 🌐\n\nThis project relies on [flutter_localizations][flutter_localizations_link] and follows the [official internationalization guide for Flutter][internationalization_link].\n\n### Adding Strings\n\n1. To add a new localizable string, open the `app_en.arb` file at `lib/l10n/arb/app_en.arb`.\n\n```arb\n{\n    \"@@locale\": \"en\",\n    \"counterAppBarTitle\": \"Counter\",\n    \"@counterAppBarTitle\": {\n        \"description\": \"Text shown in the AppBar of the Counter Page\"\n    }\n}\n```\n\n2. Then add a new key/value and description\n\n```arb\n{\n    \"@@locale\": \"en\",\n    \"counterAppBarTitle\": \"Counter\",\n    \"@counterAppBarTitle\": {\n        \"description\": \"Text shown in the AppBar of the Counter Page\"\n    },\n    \"helloWorld\": \"Hello World\",\n    \"@helloWorld\": {\n        \"description\": \"Hello World Text\"\n    }\n}\n```\n\n3. Use the new string\n\n```dart\nimport 'package:flutter_starter/l10n/l10n.dart';\n\n@override\nWidget build(BuildContext context) {\n  final l10n = context.l10n;\n  return Text(l10n.helloWorld);\n}\n```\n\n### Adding Supported Locales\n\nUpdate the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info.plist` to include the new locale.\n\n```xml\n    ...\n\n    \u003ckey\u003eCFBundleLocalizations\u003c/key\u003e\n\t\u003carray\u003e\n\t\t\u003cstring\u003een\u003c/string\u003e\n\t\t\u003cstring\u003ees\u003c/string\u003e\n\t\u003c/array\u003e\n\n    ...\n```\n\n### Adding Translations\n\n1. For each supported locale, add a new ARB file in `lib/l10n/arb`.\n\n```\n├── l10n\n│   ├── arb\n│   │   ├── app_en.arb\n│   │   └── app_es.arb\n```\n\n2. Add the translated strings to each `.arb` file:\n\n`app_en.arb`\n\n```arb\n{\n    \"@@locale\": \"en\",\n    \"counterAppBarTitle\": \"Counter\",\n    \"@counterAppBarTitle\": {\n        \"description\": \"Text shown in the AppBar of the Counter Page\"\n    }\n}\n```\n\n`app_es.arb`\n\n```arb\n{\n    \"@@locale\": \"es\",\n    \"counterAppBarTitle\": \"Contador\",\n    \"@counterAppBarTitle\": {\n        \"description\": \"Texto mostrado en la AppBar de la página del contador\"\n    }\n}\n```\n\n\n## Working with Route Navigation 🧭\n\n\u003e More info: https://gorouter.dev/\n\n## Working with Atomic Design Component 💡\n\n\u003e More info about **Atomic Design:** https://atomicdesign.bradfrost.com/\n\n\n## Package Used 📦\n\n| Name     | Category         | Info         |\n| ----------- | ----------- | ----------- |\n| [flutter_bloc](https://pub.dev/packages/flutter_bloc) | State Management  | - |\n| [bloc_concurrency](https://pub.dev/packages/bloc_concurrency) | State Management  | - |\n| [dartz](https://pub.dev/packages/dartz) | Functional Programming  | - |\n| [equatable](https://pub.dev/packages/equatable) | Equality of Object  | - |\n| [get_it](https://pub.dev/packages/get_it) | Dependency Injection  | - |\n| [go_router](https://pub.dev/packages/go_router) | Routing Navigator v2  | - |\n| [hive](https://pub.dev/packages/hive) | Local DataBase  | - |\n| [intl](https://pub.dev/packages/intl) | internationalization and localization | - |\n| [internet_connection_checker](https://pub.dev/packages/internet_connection_checker) | Utility  | - |\n| [json_annotation](https://pub.dev/packages/json_annotation) | Utility | - |\n| [path_provider](https://pub.dev/packages/path_provider) | Utility | - |\n| [stream_transformer](https://pub.dev/packages/stream_transformer) | Utility | - |\n\n[flutter_localizations_link]: https://api.flutter.dev/flutter/flutter_localizations/flutter_localizations-library.html\n[internationalization_link]: https://flutter.dev/docs/development/accessibility-and-localization/internationalization\n[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg\n[license_link]: https://opensource.org/licenses/MIT\n[logo]: https://avatars.githubusercontent.com/u/44025097?s=200\u0026v=4\n[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg\n[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis\n[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli\n[website_link]: https://wisnuwiry.space\n[codecov_badge]: https://codecov.io/gh/wisnuwiry/flutter-starter/branch/main/graph/badge.svg\n[codecov_link]: https://codecov.io/gh/wisnuwiry/flutter-starter\n[repo_link]: https://github.com/wisnuwiry/flutter-starter\n[github_action_badge]: https://github.com/wisnuwiry/flutter-starter/actions/workflows/main.yaml/badge.svg\n[github_action_workflow_link]: https://github.com/wisnuwiry/flutter-starter/actions/workflows/main.yaml\n[stars_badge]: https://img.shields.io/github/stars/wisnuwiry/flutter-starter.svg?style=flat\u0026logo=github\u0026colorB=deeppink\u0026label=Stars\n[issues_badge]: https://img.shields.io/github/issues/wisnuwiry/flutter-starter.svg?style=flat\u0026logo=github\u0026colorB=orange\u0026label=Issues\n[pull_request_badge]: https://img.shields.io/github/issues-pr/wisnuwiry/flutter-starter.svg?style=flat\u0026logo=github\u0026colorB=brightgreen\u0026label=Pull+Request\n[dart_language_badge]: https://img.shields.io/badge/Language-Dart-blue\n[pr_welcome_badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n[android_preview]: https://i.ibb.co/qNWSJ6K/android-preview.png\n[ios_preview]: https://i.ibb.co/613Gmx8/ios-preview.png\n[web_preview]: https://i.ibb.co/Y0dY43m/web-preview.png","funding_links":["https://github.com/sponsors/wisnuwiry","https://ko-fi.com/wisnuwiry","https://trakteer.id/wisnuwiry"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwisnuwiry%2Fflutter-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwisnuwiry%2Fflutter-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwisnuwiry%2Fflutter-starter/lists"}