README.md

Architecture template

Intro

This repository contains template for Applifting Flutter apps.

📚 Libraries

• Riverpod (state management)
• Freezed & json_serializable (data models, union types, JSON)
• Dio (HTTP)
• Hive (local DB)
• go_router (routing)

🌍 Localization

• Localization is done by shared Sheet document and build by flutter_localization_sheet
• Localization sheet

🌆 Assets, Fonts

• Use FlutterGen

ℹ️ Getting Started

The app has two flavours:

1. STAGE
2. PROD

This config is given in runtime by --dart-define=environment=STAGE when runnning build command. Read section below how to run the right flavour app wihout any hassle by simple predefined commands.

Setup

• This project is build with Flutter 3.3.x (for Android there is need to use 3.0.x because of internal changes in platform views)
• There is Makefile that shortcuts all common flutter commands

$ make dependencies
$ make build-runner

How to add assets (images, icons, ...)

1. Add assets
2. Run FlutterGen -> run make build-runner

Make .apk and .ipa file

Android

$ make build-android-dev
$ make build-android-prod

iOS

$ make build-ios-dev
$ make build-ios-prod

Run app

$ make run-dev
$ make run-prod