Getting Started

Requirements

• Flutter SDK: 3.35.4
• CocoaPods: 1.16.2
• JVM: 17+

How to run app

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

How to use this codebase

// table of content

• 1. Reset Project
• 2. Init Project
• 3. Config Firebase
• 4. Config Lefthook
• 5. Config Fastlane
• 6. Generate All Pages
• 7. Generate App Colors
• 8. Generate All APIs
• 9. Generate UI from Figma
• 10. Other Tools

1. Reset Project

• Run make reset to clean up example code and reset project to initial state

2. Init Project

• Run make gen_env to generate setting_initial_config.md file
• Fill the JSON values in the setting_initial_config.md file
• Run make init

3. Config Firebase

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

4. Config Lefthook

• Install lefthook
• Run lefthook install
• Update commit message rule: commit-msg.sh and check_commit_message.sh
• Update branch name rule: pre-commit.sh and bitbucket-pipelines/pull-requests

5. Config Fastlane

• Install Fastlane
• Run make fastlane_update_plugins
• Put the .p8 file in folder ios
• Update config values in:
  • ios/Fastfile
  • android/Fastfile
  • .env.default

6. Generate all pages

• Fill all pages need to be generated in lib/ui/page/input_pages.md file
• Run make gap to generate all empty pages including *.freezed.dart, *.gr.dart files without running the command make fb

7. Generate app colors

• Make sure Figma MCP is running
• Use the generate_app_colors_prompt with [YOUR_FIGMA_LINK] replaced by your Figma link to generate app colors in lib/resource/app_colors.dart file

8. Generate all APIs (methods and models)

• Place your OpenAPI JSON specification file in the docs/api_doc folder
• Run make gen_api to generate API methods and model classes with default settings (append mode, using docs/api_doc)
• Run make fb to generate the necessary build files after API generation

Advanced Usage:

# Basic usage (uses default input_path=docs/api_doc, replace=false)
make gen_api

# Generate specific APIs only
make gen_api apis=get_v1/users,post_v1/auth,get_v2/profile

# Replace all existing generated code instead of appending
make gen_api replace=true

# Use custom input path
make gen_api input_path=custom/swagger/docs

# Use custom output path
make gen_api output_path=lib/custom/api

# Combine multiple options
make gen_api input_path=swagger/docs replace=true apis=get_v1/search,post_v2/city

What gets generated:

• API Methods: Added to lib/data_source/api/app_api_service.dart (after the generated marker)
• Model Classes: Created in lib/model/api/ folder with Freezed annotations
• Nested Classes: Automatically generated for complex response structures

Notes:

• The tool uses _authAppServerApiClient by default for all APIs
• Manually modify methods that should use _noneAuthAppServerApiClient if needed
• Generated code is marked with // GENERATED CODE - DO NOT MODIFY OR DELETE THIS COMMENT
• In append mode (default), new methods are added without removing existing ones
• In replace mode, all code below the marker is replaced

9. Generate UI from Figma

• Make sure Figma MCP is running
• Download all images used in the Figma design to assets/images folder
• Run make ga to generate all assets in app_images.dart file
• Fill screen spec in *_spec.md file in the page folder
• Attach the image (.png) of design from Figma to the /design folder (same level as the *_test.dart file in the widget_test folder)
• Use the generate_page_prompt with:
• [YOUR_FIGMA_LINK] replaced by your Figma link to generate
• [SNAKE_CASE_SCREEN_NAME] replaced by your screen name in snake_case
• Attach the image (.png) of design from Figma to the prompt

10. Other tools

• TOOLS.md