Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wisnuwiry/flutter-starter

A boilerplate project was created in flutter using Clean Architecture & TDD.
https://github.com/wisnuwiry/flutter-starter

boilerplate boilerplate-template clean-architecture clean-code dart dependency-injection dio flutter flutter-bloc injector state-management

Last synced: about 2 months ago
JSON representation

A boilerplate project was created in flutter using Clean Architecture & TDD.

Host: GitHub
URL: https://github.com/wisnuwiry/flutter-starter
Owner: wisnuwiry
License: mit
Created: 2021-04-17T13:04:09.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-08-10T04:01:05.000Z (over 2 years ago)
Last Synced: 2024-10-12T05:47:29.294Z (2 months ago)
Topics: boilerplate, boilerplate-template, clean-architecture, clean-code, dart, dependency-injection, dio, flutter, flutter-bloc, injector, state-management
Language: Dart
Homepage:
Size: 3.47 MB
Stars: 27
Watchers: 2
Forks: 10
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # Flutter Starter

[![Wisnuwiry][logo]][website_link]

[![Language][dart_language_badge]](http://dart.dev)

[![Flutter Starter][github_action_badge]][github_action_workflow_link]

[![Codecov][codecov_badge]][codecov_link]

[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]

[![License: MIT][license_badge]][license_link]

[![PRs Welcome][pr_welcome_badge]][repo_link]

[![Stars][stars_badge]][repo_link]

[![Stars][issues_badge]][repo_link]

[![Stars][pull_request_badge]][repo_link]

A Flutter Starter Project created by the [Wisnu G. Saputra][website_link].

---

## Preview 🪟

| Android     | iOS         | Web         |

| ----------- | ----------- | ----------- |

| ![Android][android_preview] | ![iOS][ios_preview]  | ![Web][web_preview] |

## Getting Started 🚀

This project contains 3 flavors:

- development

- staging

- production

For 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:

```

BASE_URL_PROD = 

BASE_URL_STG  = 

BASE_URL_DEV  = 

```

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

```

_\*Flutter Starter works on iOS, Android, and Web._

---

## Build App 🔥

To build APK desired flavor use the following commands:

```sh

# Development

$ flutter build apk --flavor development --target lib/main_development.dart

# Staging

$ flutter build apk --flavor staging --target lib/main_staging.dart

# Production

$ flutter build apk --flavor production --target lib/main_production.dart

```

And 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.

---

## 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:flutter_starter/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"

    }

}

```

## Working with Route Navigation 🧭

> More info: https://gorouter.dev/

## Working with Atomic Design Component 💡

> More info about **Atomic Design:** https://atomicdesign.bradfrost.com/

## Package Used 📦

| Name     | Category         | Info         |

| ----------- | ----------- | ----------- |

| [flutter_bloc](https://pub.dev/packages/flutter_bloc) | State Management  | - |

| [bloc_concurrency](https://pub.dev/packages/bloc_concurrency) | State Management  | - |

| [dartz](https://pub.dev/packages/dartz) | Functional Programming  | - |

| [equatable](https://pub.dev/packages/equatable) | Equality of Object  | - |

| [get_it](https://pub.dev/packages/get_it) | Dependency Injection  | - |

| [go_router](https://pub.dev/packages/go_router) | Routing Navigator v2  | - |

| [hive](https://pub.dev/packages/hive) | Local DataBase  | - |

| [intl](https://pub.dev/packages/intl) | internationalization and localization | - |

| [internet_connection_checker](https://pub.dev/packages/internet_connection_checker) | Utility  | - |

| [json_annotation](https://pub.dev/packages/json_annotation) | Utility | - |

| [path_provider](https://pub.dev/packages/path_provider) | Utility | - |

| [stream_transformer](https://pub.dev/packages/stream_transformer) | Utility | - |

[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

[logo]: https://avatars.githubusercontent.com/u/44025097?s=200&v=4

[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

[website_link]: https://wisnuwiry.space

[codecov_badge]: https://codecov.io/gh/wisnuwiry/flutter-starter/branch/main/graph/badge.svg

[codecov_link]: https://codecov.io/gh/wisnuwiry/flutter-starter

[repo_link]: https://github.com/wisnuwiry/flutter-starter

[github_action_badge]: https://github.com/wisnuwiry/flutter-starter/actions/workflows/main.yaml/badge.svg

[github_action_workflow_link]: https://github.com/wisnuwiry/flutter-starter/actions/workflows/main.yaml

[stars_badge]: https://img.shields.io/github/stars/wisnuwiry/flutter-starter.svg?style=flat&logo=github&colorB=deeppink&label=Stars

[issues_badge]: https://img.shields.io/github/issues/wisnuwiry/flutter-starter.svg?style=flat&logo=github&colorB=orange&label=Issues

[pull_request_badge]: https://img.shields.io/github/issues-pr/wisnuwiry/flutter-starter.svg?style=flat&logo=github&colorB=brightgreen&label=Pull+Request

[dart_language_badge]: https://img.shields.io/badge/Language-Dart-blue

[pr_welcome_badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg

[android_preview]: https://i.ibb.co/qNWSJ6K/android-preview.png

[ios_preview]: https://i.ibb.co/613Gmx8/ios-preview.png

[web_preview]: https://i.ibb.co/Y0dY43m/web-preview.png