Download and set the project

Run the project locally

1. Clone the project from: project repo.

   WARNING

   Do not install Flutter to a directory or path that meets any of the following conditions:

   • The path contains special characters or spaces.

   • The path requires elevated privileges.

   As an example, C:\Program Files\, ~/dev/我的專案/ fails the condition(s) listed above.

2. Open the project with your IDE.
   Run the following command to get project's dependency packages:

   flutter pub get

   WARNING

   The project uses Flutter 3.47.6 (Dart 3.13.5). The version is recorded in .fvmrc at the project root.
   Run flutter --version first to check your version. flutter pub get fails if your version is lower than 3.47.

   If you use FVM, run the following commands to install the project's version. Then run every later command with fvm flutter or fvm dart:

   fvm install
   fvm flutter pub get

3. Run the following command to generate additional dart code:

   dart run build_runner build

   TIP

   build_runner replaces existing generated files (xxx.g.dart) automatically. You do not need any extra option.

4. Run the process.

   Select target device, Run the project.

   ▼ In Android Studio select Pixel 7 Pro (mobile) as target device

   

   1. Select device:

      • Following the order of [1] and [2]。

        INFO

        

      • Open Command Palette. Hot key: ⌘ command + ⇧ shift + P (Windows: ctrl + shift + P)。
        In the Command Palette, type flutter.
        Select Flutter: Select Device.
        Select target device.

   2. Go to Run > Start Debugging or press F5.

   Use the command:

   flutter run

   It will locate the available device automtically.
   If you have multiple devices available, follow the instruction to select the one you want to use. the message should resemble:

   Connected devices:
   Pixel 6 (mobile)                • XxXxXxXxXxXxXx        • android-arm64 • Android ...
   sdk gphone64 arm64 (mobile)     • emulator-1234         • android-arm64 • Android ... (emulator)
   Mac Designed for iPad (desktop) • mac-designed-for-ipad • darwin        • macOS 14.5 23F79 darwin-arm64
   
   No wireless devices were found.
   
   [1]: Pixel 6 (XxXxXxXxXxXxXx)
   [2]: sdk gphone64 arm64 (emulator-1234)
   [3]: Mac Designed for iPad (mac-designed-for-ipad)
   Please choose one (or "q" to quit):

   In the example above, use 1, 2 or 3 to choose the device.

TIP

Flutter offers a fast development cycle with Stateful Hot Reload, the ability to reload the code of a live running app without restarting or losing app state.

For more info about Hot Reload: Official Document.