YOUR_PROJECT_NAME

The simple Flutter project

Getting Started

Requirements

• Flutter SDK: 3.35.1
• CocoaPods: 1.16.2

How to run app

• cd to root folder of project
• Run make gen_env
• Run make sync
• Run app via IDE
• Enjoy!

Starting new project

1. Config multi-flavors and Firebase

• Change flavor settings:

  • Replace all jp.flutter.app by your project bundle id (application id)
  • Config flavors for Android at build.gradle
    • Application name: find and change values of: manifestPlaceholders["applicationName"]
    • Version name: find and change values of: versionName
    • Version code: find and change values of: versionCode
  • Config flavors for iOS at:
    • Develop.xcconfig
    • Qa.xcconfig
    • Staging.xcconfig
    • Production.xcconfig

• Config Firebase

  • Android: Paste your google services files to:
    • Develop
    • Qa
    • Staging
    • Production
  • iOS: Paste your google services files to:
    • Develop
    • Qa
    • Staging
    • Production

2. Secrets configuration

• Define secret constants in env.dart and JSON files in folder dart_defines including:
  • dart_defines/develop.json
  • dart_defines/qa.json
  • dart_defines/staging.json
  • dart_defines/production.json

For example:

{
  "FLAVOR": "develop",
  "APP_BASIC_AUTH_NAME": "admin",
  "APP_BASIC_AUTH_PASSWORD": "admin"
}

3. Other configs

• designDeviceWidth, designDeviceHeight, materialAppTitle, taskMenuMaterialAppColor, systemUiOverlay, mobileOrientation, tabletOrientation in constant.dart

4. Update README.md

• YOUR_PROJECT_NAME and the project description
• Upgrade Flutter if needed

5. Setup Fastlane (optional)

• Install Fastlane
• Run make fastlane_update_plugins
• Create a single file .env.default at the project root
• Paste this into the file

SLACK_HOOKS_URL=https://hooks.slack.com/services/xxx
ISSUER_ID=xxx
FIREBASE_TOKEN=1//xxx
MENTIONS=@minhnt3
MESSAGE=Xin các anh chị tester nhẹ tay giúp!
DEV_FLAVOR=develop
QA_FLAVOR=qa
STG_FLAVOR=staging

• Put the .p8 file in folder ios
• Update config values in ios/Fastfile and android/Fastfile

6. Setup Lefthook (optional)

• Replace all text: NFT by YOUR_PROJECT_CODE in:
  • Commit message rule: commit-msg.sh and check_commit_message.sh
  • Branch name rule: pre-commit.sh and bitbucket-pipelines/pull-requests
• Run lefthook install

Note

1. Upgrading Flutter

• Please update these files when upgrading Flutter version:
  • README.md
  • bitbucket-pipelines.yml
  • Jenkinsfile
  • codemagic.yaml
  • ci.yaml
  • cd_develop.yaml
  • cd_qa.yaml
  • cd_staging.yaml
  • cd_production.yaml