flutter_starter

Flutter starter project with workflow automation.

Workflows

	Trigger	Badge
:information_source:	PR merge event (destination: trunk)
:information_source:	Scheduled (weekly)
:information_source:	PR open event (destination: trunk)

Requirements

In order to run own copy of the project one must fulfill the following requirements.

Supported operating systems

• :trophy: Debian based Linux - recommended
  • check out this dev setup instructions to facilitate setting up the dev environment;
• :ok: OSX - should work due to the similarities with Linux
  • one will have to figure out oneself how to set up the dev environment;

Core dependencies

• Git
• Bash 5
• Flutter

Setting up Flutter on a Debian based Linux

Check out this repository WDSDU. It has automated installation instructions for Debian based Linux distributions.

To install everything clone WDSDU

cd ./proj # or whatever your git projects folder is
git clone git@github.com:rfprod/wdsdu.git

, cd into the project directory, execute instal.sh and pay attention to the prompts in the terminal where the install.sh was executed

cd ./wdsdu
bash ./install.sh

Working with the project

Use the Flutter CLI to work with the project.

Getting Started

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

• Lab: Write your first Flutter app
• Cookbook: Useful Flutter samples

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Environment variables

Create an .env file in the project root with the following values

SENTRY_DSN='...'
FIRE_API_KEY='...'
FIRE_APP_ID='...'
FIRE_MESSAGING_SENDER_ID='...'
FIRE_PROJECT_ID='...'

Google services integration

Create the google-services.json file in the ./android/app directory.

Quick references

1. show help

flutter --help

1. list available emulators

flutter emulators

Example output

$ flutter emulators
1 available emulator:

api34device • api34device •  • android

To run an emulator, run 'flutter emulators --launch <emulator id>'.
To create a new emulator, run 'flutter emulators --create [--name xyz]'.

You can find more information on managing emulators at the links below:
  https://developer.android.com/studio/run/managing-avds
  https://developer.android.com/studio/command-line/avdmanager

1. launch an emulator

Replace api34device with the name of the emulator you configured locally

flutter emulators --launch api34device

1. list connected devices

flutter devices list

Example output

$ flutter devices list
Found 3 connected devices:
  sdk gphone64 x86 64 (mobile) • emulator-5554 • android-x64    • Android 14 (API 34) (emulator)
...

1. run the application on the emulator

flutter run

Technologies Reference

Client

• Flutter
• Flutter CLI

Server

• Firebase

API integrations

• Blockchain
• CoinGecko // TBI

CI

• GitHub Actions

Development methodology

• Trunk based development