YOUR_PROJECT_NAME

The simple Flutter project

Test Coverage

Including Unit Tests, Widget Tests, Golden Tests, and Integration Tests

Screenshots

Chat Page

Light	Dark

Contact List Page

Light	Dark

Register Page

Light	Dark

My Page

Light	Dark

Getting Started

Requirements

• Dart: 3.5.3
• Flutter SDK: 3.24.3
• CocoaPods: 1.15.0

How to run app

• cd to root folder of project
• Run make gen_env
• Run make sync
• Run app via VSCode or using command make run_dev
• 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)

• Create files .env.default in ios/fastlane and android/fastlane
• Paste this into files .env.default

SLACK_URL = "https://hooks.slack.com/services/xxx"
APP_CENTER_TOKEN = "xxx"
APPLE_TOKEN = "xxx"
FIREBASE_TOKEN = "1//xxx"

• Update config values in ios/Fastfile and android/Fastfile

6. Setup Jenkins (optional)

• Update tokenCredentialId, channel in Jenkinsfile

7. 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