Skip to content

Latest commit

 

History

History
310 lines (204 loc) · 11.9 KB

README.md

File metadata and controls

310 lines (204 loc) · 11.9 KB
Raw

Overview 🐄

Welcome to the Surf Flutter Team's project template – your springboard for launching new Flutter projects with ease and efficiency. Our template encapsulates years of experience and best practices in Flutter development, providing a solid foundation for your project. Here's what's included:

  • 🏗️ Project Structure: Adopt the tried-and-true structure we use across our projects, providing clarity and consistency.
  • 📚 Basic Documentation: Understand our project structure with the included basic documentation, making onboarding smooth and straightforward.
  • 🔄 FVM Integration: Enjoy seamless Flutter version management with Flutter Version Management (FVM) already integrated.
  • 🍦 Pre-Configured Flavors: We've set up basic flavors for your project – Production, and Development – to streamline your workflow.
  • 🎨 App Icon & Splash Screen Setup: Dive right in with pre-configured app icons and splash screens, enhancing the user experience from the start.
  • 🌍 Localization Setup: Reach a global audience with our ready-to-use localization setup.
  • 📦 Default Libraries: Benefit from a suite of libraries that we regularly use, included by default for your convenience.
  • 🛠️ Essential Project Scripts: Access important project scripts like code generation and cache cleaning, saving time and effort.
  • ✨ Basic Features: Our template includes essential features such as first-run checks, theme switching, configuration storage, and a debug screen.
  • 💉 Dependency Injection Configuration: Streamline your coding with our pre-configured Dependency Injection setup.
  • 🛠️ Utilities: Utilize the same handy utilities that have become a staple in our projects.
  • 🏛️ Architectural Approaches with Elementary: Our architectural methodologies based on the Elementary library, ensuring robust and scalable app architecture.

This template is more than just a starting point – it's a culmination of our expertise, designed to elevate your Flutter projects right from the beginning. Enjoy the ease of development with the Surf Flutter Team's touch!

Quick Start 🚀

Important

This section needs to be removed after template initialization.

A project initialization template adopted at Surf.

Template initialization

Do the following to initialize a project:

  1. Specify the name of the application here.

  2. Search for flutter_template and replace it with the name of your project where needed.

  3. Configure Firebase with the guide.

  4. Initialize FirebaseCrashlytics (you can find that in TODO(init-project)).

  5. Install a needed Flutter version with FVM using the command:

    fvm use <flutter_version>

    If FVM is not installed, check FVM workflow.

  6. Specify the Flutter version used in the project here.

  7. Setup labels for issues and pull requests in the repository settings according to the list.

Workflow in the template repository

The rules for branches, commits, and pull requests are the same as for a project repository workflow and explained below.

One more thing

Important

If you find that some information or code in the template is outdated or found errors, do not be lazy and make a change request in the template repository. Thank you.

Enter App Name Here

Important

Enter the application name above and delete this alert.

Basic information

Note

Add here basic information about the project, such as:

  • a couple words what the project is about
  • briefly, what technologies are used (BLoC, Riverpod, something specific, etc.)
  • link to Confluence space with all project documentation

Settings

Project line length: 120 characters.

Dependencies

Run this command to get up-to-date versions of dependencies:

fvm flutter pub get --enforce-lockfile

Flutter Version Management (FVM)

Flutter and Dart FVM versions of the project

Important

Change Flutter and Dart versions below and delete this alert.

Flutter: 3.19.0 / Dart SDK: 3.3.0

FVM workflow

The project uses FVM for Flutter version management. Installation and IDE configuration for working with FVM are described here and here.

For installation the project version of Flutter, run the command:

fvm install

For VSCode IDE you can also run the script fvm_vscode.sh:

sh scripts/fvm_vscode.sh

You need to use fvm flutter ... everywhere instead of just flutter ... when working with the project.

Code generation

Basic command for code generation:

fvm flutter pub run build_runner build --delete-conflicting-outputs

Assets codegen

You can easily add assets to your project by following these steps:

  1. Add asset to your assets folder (make sure you specify this folder in asset section of your pubspec.yaml)

  2. Run script spider_build.sh:

    sh scripts/spider_build.sh

Spider configuration file is located here.

Note

Add relevant information such as:

  • API models and services generation (basic info about SurfGen is here)
  • generating something else that is necessary for work or project launch

Delete this alert after initialization of the template.

Mason

The project uses mason to generate code based on templates. To install mason you need to run the command:

# Install from pub.dev
dart pub global activate mason_cli

# Or

# Install from  homebrew
brew tap felangel/mason
brew install mason

The project uses 2 templates - feature and screen. In order for templates to be used, they need to be obtained from mason.yaml. Run the following command:

mason get

To generate code based on a template, you need to run the following command:

mason make TEMPLATE_NAME # insert the template 'feature' or 'screen' instead of TEMPLATE_NAME

Requirements for running the app

Note

Add relevant information such as:

  • VPN settings for development
  • test/development accounts

Or just put "No". Delete this alert, but don't delete this section.

Project scripts

All scripts are located in the scripts folder and described here.

Build

Versioning

Note

Explain here a versioning system used in the project.

Delete this alert after initialization of the template.

For example, you can use this approach:

Given the version number MAJOR.MINOR.PATCH, the following should be incremented:

  • MAJOR version, based on the last number of release year 2021 -> 1, 2022 -> 2, 2023 -> 3, ...
  • MINOR version, month of release -> 1, 2, 3 ... 12
  • PATCH version, the day on which the release is made -> 1, 2, 3, ... 31

Build number or versionCode, which comes after +, is added following this rule — combine all the values of the application version and add a place for version counting.

3.11.29+31129000 // first build for the date November 29, 2023
3.11.29+31129001 // second build for the date November 29, 2023
4.01.03+30103001 // second build for the date January 3, 2024

Flavors

The project has two flavors: dev and prod. The dev flavor is used by default. The guide to adding flavors can be found here.

There are cases when you need to add different functionality for dev and qa mode. For example, if you need different logging or feature-toggle options. Then you can add the qa mode to the enum BuildType and create a main_qa.dart file with the main() function in the lib/ folder. For example:

void main() {
  run(const Environment(buildType: BuildType.qa));
}

Then you need to add qa flavor (guide).

Build guides

Note

Add here guides for building the app or skip this section.

Delete this alert, but don't delete this section.

App Signature, Certs and secrets

Android Application Signature guide can be found here.

iOS certs and profiles should be saved here: ios/certs. But don't store them in the project repository!

Problems and possible solutions

Note

Add problems and possible solutions here as you work with the project.

Delete this alert, but don't delete this section.

Workflow in a repository

The workflow includes the following:

Architecture and project structure

The overview of the architecture and structure can be found here:

Analytics

Enabled:

Navigation

Navigation is centered around the AutoRoute package. We use a class called AppRouter for global navigation around an app and StackRouter for nested navigation.

Despite the fact that StackRouter could be referred to directly through the context in WidgetModel, it should be passed explicitly to the WidgetModel constructor. With StackRouter used in the context, an effective navigation stack can be obtained and managed in this router. AppRouter, in turn, is stored in the AppScope dependencies and recovered from there.

DI

Provider is our choice for DI.

Dependencies are grouped into container entities with an interface describing a set of dependencies supplied. This entity is, in turn, supplied to a functionality with a DiScope widget, which is used as a wrapper for a corresponding functionality.

For example, AppScope is the base entity for the entire app. It contains dependencies that function through the entire lifecycle of the app. We wrap the whole app in the DiScope and pass a factory that returns the AppScope. If a functionality needs some dependencies specific to it only, they are isolated into a separate entity, which is to be wrapped around the functionality.

Localization

The basic rules and tips for working with localization are described in guide. More information on working with localization can be found here.

Theming

The basic rules and tips for working with theming are described in the guide.

Icons launcher

The basic rules and tips for working with icon generation are described in the guide.

Native splash screen

The Basic guide for creating a native splash screen is here.

Additional useful practices

There are some additional useful guides in the docs folder: