Skip to content

DevFin - Real-time financial news, markets data and investing analysis

Notifications You must be signed in to change notification settings

huykgit98/devfin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

coverage style: very good analysis License: MIT

Generated by the Very Good CLI 🤖

Devfin

This project utilizes Very good layered architecture developed by Felix Angelov, the creator of the BLoC library, and his team at Very Good Ventures.


Features

Technologies used

Flutter app used

  1. Using flutter_bloc for state management, and also utilizing Riverpod for simple use-cases such as theme switching and language switching.
  2. Very good layered architecture recommended by VeryGoodVentures
  3. go_router for navigation and routing
  4. Service Locator using get_it and injectable packages
  5. l10n using flutter_localization via .arb
  6. using ShoreBird code-push for unplanned features (ShoreBird is similar to Flutter's hot reload feature, but it operates in production environment)
  7. using Firebase Remote Config planned features

Screenshot

Todo

Verygood Ventures Documentation

Getting Started 🚀

This project contains 3 flavors:

  • development
  • staging
  • production

To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:

# 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

*Devfin works on iOS, Android, Web, and Windows.


Running Tests 🧪

To run all unit and widget tests use the following command:

$ flutter test --coverage --test-randomize-ordering-seed random

To view the generated coverage report you can use lcov.

# 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 and follows the official internationalization guide for Flutter.

Adding Strings

  1. To add a new localizable string, open the app_en.arb file at lib/l10n/arb/app_en.arb.
{
    "@@locale": "en",
    "counterAppBarTitle": "Counter",
    "@counterAppBarTitle": {
        "description": "Text shown in the AppBar of the Counter Page"
    }
}
  1. Then add a new key/value and description
{
    "@@locale": "en",
    "counterAppBarTitle": "Counter",
    "@counterAppBarTitle": {
        "description": "Text shown in the AppBar of the Counter Page"
    },
    "helloWorld": "Hello World",
    "@helloWorld": {
        "description": "Hello World Text"
    }
}
  1. Use the new string
import 'package:devfin/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.

    ...

    <key>CFBundleLocalizations</key>
	<array>
		<string>en</string>
		<string>es</string>
	</array>

    ...

Adding Translations

  1. For each supported locale, add a new ARB file in lib/l10n/arb.
├── l10n
│   ├── arb
│   │   ├── app_en.arb
│   │   └── app_es.arb
  1. Add the translated strings to each .arb file:

app_en.arb

{
    "@@locale": "en",
    "counterAppBarTitle": "Counter",
    "@counterAppBarTitle": {
        "description": "Text shown in the AppBar of the Counter Page"
    }
}

app_es.arb

{
    "@@locale": "es",
    "counterAppBarTitle": "Contador",
    "@counterAppBarTitle": {
        "description": "Texto mostrado en la AppBar de la página del contador"
    }
}

References

Setting up muti-flavor with Firebase

  1. Creating Development Environments for Firebase using the Very Good & Flutterfire CLIs in Flutter
  2. Flutter Flavors Setup with multiple Firebase Environments using FlutterFire and Very Good CLI
  3. Practical Guide: Flutter + Firebase + FlutterFire CLI + CI (Codemagic)
  4. Flutter iOS — Setup Flavors with different Firebase Config

About

DevFin - Real-time financial news, markets data and investing analysis

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages