Flutter: Difference between revisions

(19 intermediate revisions by 10 users not shown)

Line 1:

[https://flutter.dev Flutter] is an open-source mobile application development framework created by Google. It allows developers to build high-performance, cross-platform apps for iOS and Android using a single codebase.

In order to understand the sections below more for Android development on NixOS, [[Android|check out the Android wiki page]].

== Development ==

Create following <code>flake.nix</code> in a new project directory

=== Linux desktop/Web ===

To build Flutter apps to Linux desktop or Web you only need the <code>flutter</code> package from Nixpkgs.

Then run <code>flutter build linux</code> or <code>flutter build web</code>. Ensure that <code>pkg-config</code> is installed on your system, either through a development shell or directly on the base system. Not having <code>pkg-config</code> available may result in compilation errors.

=== Android ===

The easiest way is to install Android Studio by adding <code>pkgs.android-studio</code> to your list of packages in configuration.nix.

If you prefer [[Vscode|VSCode]], you can create a [[Development environment with nix-shell|dev-shell]] with the packages "jdk", "flutter", and a preferred android sdk such as the preconfigured one "androidenv.androidPkgs_9_0.androidsdk" (mentioned in the Android wiki page). Add other packages if missing any. Or you can install Android Studio to get all the Android packages, and install Flutter.

Below is an example [[Flakes|flake.nix]] for creating a dev shell. Create following <code>flake.nix</code> in a new project directory

{{file|flake.nix|nix|<nowiki>

{

description = "Flutter 3.0.4";

description = "Flutter 3.13.x";

inputs = {

nixpkgs.url = "github:NixOS/nixpkgs/23.05";

nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";

flake-utils.url = "github:numtide/flake-utils";

};

Line 22:

Line 35:

};

buildToolsVersion = "30.0.3";

buildToolsVersion = "34.0.0";

androidComposition = pkgs.androidenv.composeAndroidPackages {

buildToolsVersions = [ buildToolsVersion "28.0.3" ];

platformVersions = [ "31" "28" ];

platformVersions = [ "34" "28" ];

abiVersions = [ "armeabi-v7a" "arm64-v8a" ];

};

androidSdk = androidComposition.androidsdk;

in

{

devShell =

with pkgs; mkShell rec {

ANDROID_SDK_ROOT = "${androidSdk}/libexec/android-sdk";

buildInputs = [

flutter

androidSdk # The customized SDK that we've made above

jdk17

];

};

});

}

</nowiki>}}

If you don't want to customize the android sdk, you can instead use the predefined packages, as mentioned [https://nixos.org/manual/nixpkgs/unstable/#using-predefined-android-package-compositions in this section on the manual], such as <code>androidenv.androidPkgs_9_0.androidsdk</code>:

{{file|flake.nix|nix|<nowiki>

{

description = "Flutter 3.13.x";

inputs = {

nixpkgs.url = "github:NixOS/nixpkgs/23.11";

flake-utils.url = "github:numtide/flake-utils";

};

outputs = { self, nixpkgs, flake-utils }:

flake-utils.lib.eachDefaultSystem (system:

let

pkgs = import nixpkgs {

inherit system;

config = {

android_sdk.accept_license = true;

allowUnfree = true;

};

androidSdk = pkgs.androidenv.androidPkgs_9_0.androidsdk;

in

{

Line 37:

Line 85:

flutter

androidSdk

~~jdk11~~

jdk17

];

};

Line 43:

Line 91:

}

</nowiki>}}

Run following commands to start a new demo project and run the "hello world" application

Line 52:

Line 101:

# flutter run

</syntaxhighlight>

== Emulators ==

[[Android|View the Android wiki page for more info]], but you can set up emulators in Android Studio, run them from there, then target the emulator in VSCode when running your flutter code. Otherwise, you can Nixify or even manually add your emulators as stated in the Android wiki page

== Packaging ==

Use [https://github.com/NixOS/nixpkgs/blob/cfe96dbfce8bd62dcd4a8ad62cb79dec140b1a62/pkgs/development/compilers/flutter/flutter.nix#L168 buildFlutterApplication from nixpkgs].

== Troubleshooting ==

* The default Gradle template for android captures the Android and Flutter SDK paths in <code>android/local.properties</code> preventing future updates to the SDK from participating in the build. This manifests itself as Gradle failing to install SDK components registered in the shell. To fix, simply delete the properties file and run the build again.<syntaxhighlight lang="shell-session">FAILURE: Build failed with an exception.

* Where:

Build file /xxx/android/build.gradle.kts' line: 16

* What went wrong:

A problem occurred configuring project ':app'.

> com.android.builder.sdk.InstallFailedException: Failed to install the following SDK components:

ndk;26.3.11579264 NDK (Side by side) 26.3.11579264

The SDK directory is not writable (/nix/store/1xw5npxd7isrl50pl7y82anhdapnfs6p-androidsdk/libexec/android-sdk)</syntaxhighlight>Alternatively, adjust <code>composeAndroidPackages</code> to include the exact version of the SDK components flutter requires. In the example above, simply add the <code>ndkVersion</code> as in the example below.

{{Code|1=...

androidComposition = pkgs.androidenv.composeAndroidPackages {

...

ndkVersions = [ "26.3.11579264" ]

...

};

...}}

== See also ==

* The [https://github.com/orgs/NixOS/teams/flutter team working on flutter in nixpkgs] maintains several pieces of infrastructure related to the cause. The documentation is lacking as of now, but there are plans to improve it.

[[Category: Development]]

@@ Line 1: / Line 1: @@
 [https://flutter.dev Flutter] is an open-source mobile application development framework created by Google. It allows developers to build high-performance, cross-platform apps for iOS and Android using a single codebase.
+In order to understand the sections below more for Android development on NixOS, [[Android|check out the Android wiki page]].
 == Development ==
-Create following <code>flake.nix</code> in a new project directory
+=== Linux desktop/Web ===
+To build Flutter apps to Linux desktop or Web you only need the <code>flutter</code> package from Nixpkgs.
+Then run <code>flutter build linux</code> or <code>flutter build web</code>. Ensure that <code>pkg-config</code> is installed on your system, either through a development shell or directly on the base system. Not having <code>pkg-config</code> available may result in compilation errors.
+=== Android ===
+The easiest way is to install Android Studio by adding <code>pkgs.android-studio</code> to your list of packages in configuration.nix.
+If you prefer [[Vscode|VSCode]], you can create a [[Development environment with nix-shell|dev-shell]] with the packages "jdk", "flutter", and a preferred android sdk such as the preconfigured one "androidenv.androidPkgs_9_0.androidsdk" (mentioned in the Android wiki page). Add other packages if missing any. Or you can install Android Studio to get all the Android packages, and install Flutter.
+Below is an example [[Flakes|flake.nix]] for creating a dev shell. Create following <code>flake.nix</code> in a new project directory
 {{file|flake.nix|nix|<nowiki>
 {
-description = "Flutter 3.0.4";
+description = "Flutter 3.13.x";
 inputs = {
-   nixpkgs.url = "github:NixOS/nixpkgs/23.05";
+   nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
    flake-utils.url = "github:numtide/flake-utils";
 };
@@ Line 22: / Line 35: @@
          };
        };
-       buildToolsVersion = "30.0.3";
+       buildToolsVersion = "34.0.0";
        androidComposition = pkgs.androidenv.composeAndroidPackages {
          buildToolsVersions = [ buildToolsVersion "28.0.3" ];
-         platformVersions = [ "31" "28" ];
+         platformVersions = [ "34" "28" ];
          abiVersions = [ "armeabi-v7a" "arm64-v8a" ];
        };
        androidSdk = androidComposition.androidsdk;
+    in
+    {
+      devShell =
+        with pkgs; mkShell rec {
+          ANDROID_SDK_ROOT = "${androidSdk}/libexec/android-sdk";
+          buildInputs = [
+            flutter
+            androidSdk # The customized SDK that we've made above
+            jdk17
+          ];
+        };
+    });
+}
+</nowiki>}}
+If you don't want to customize the android sdk, you can instead use the predefined packages, as mentioned [https://nixos.org/manual/nixpkgs/unstable/#using-predefined-android-package-compositions in this section on the manual], such as <code>androidenv.androidPkgs_9_0.androidsdk</code>:
+{{file|flake.nix|nix|<nowiki>
+{
+description = "Flutter 3.13.x";
+inputs = {
+  nixpkgs.url = "github:NixOS/nixpkgs/23.11";
+  flake-utils.url = "github:numtide/flake-utils";
+};
+outputs = { self, nixpkgs, flake-utils }:
+  flake-utils.lib.eachDefaultSystem (system:
+    let
+      pkgs = import nixpkgs {
+        inherit system;
+        config = {
+          android_sdk.accept_license = true;
+          allowUnfree = true;
+        };
+      };
+      androidSdk = pkgs.androidenv.androidPkgs_9_0.androidsdk;
      in
      {
@@ Line 37: / Line 85: @@
              flutter
              androidSdk
-             jdk11
+             jdk17
            ];
          };
@@ Line 43: / Line 91: @@
 }
 </nowiki>}}
 Run following commands to start a new demo project and run the "hello world" application
@@ Line 52: / Line 101: @@
 # flutter run
 </syntaxhighlight>
+== Emulators ==
+[[Android|View the Android wiki page for more info]], but you can set up emulators in Android Studio, run them from there, then target the emulator in VSCode when running your flutter code. Otherwise, you can Nixify or even manually add your emulators as stated in the Android wiki page
 == Packaging ==
 Use [https://github.com/NixOS/nixpkgs/blob/cfe96dbfce8bd62dcd4a8ad62cb79dec140b1a62/pkgs/development/compilers/flutter/flutter.nix#L168 buildFlutterApplication from nixpkgs].
+== Troubleshooting ==
+* The default Gradle template for android captures the Android and Flutter SDK paths in <code>android/local.properties</code> preventing future updates to the SDK from participating in the build. This manifests itself as Gradle failing to install SDK components registered in the shell. To fix, simply delete the properties file and run the build again.<syntaxhighlight lang="shell-session">FAILURE: Build failed with an exception.
+* Where:
+Build file /xxx/android/build.gradle.kts' line: 16
+* What went wrong:
+A problem occurred configuring project ':app'.
+> com.android.builder.sdk.InstallFailedException: Failed to install the following SDK components:
+      ndk;26.3.11579264 NDK (Side by side) 26.3.11579264
+  The SDK directory is not writable (/nix/store/1xw5npxd7isrl50pl7y82anhdapnfs6p-androidsdk/libexec/android-sdk)</syntaxhighlight>Alternatively, adjust <code>composeAndroidPackages</code> to include the exact version of the SDK components flutter requires. In the example above, simply add the <code>ndkVersion</code> as in the example below.
+{{Code|1=...
+      androidComposition = pkgs.androidenv.composeAndroidPackages {
+         ...
+         ndkVersions = [ "26.3.11579264" ]
+         ...
+      };
+...}}
 == See also ==
 * The [https://github.com/orgs/NixOS/teams/flutter team working on flutter in nixpkgs] maintains several pieces of infrastructure related to the cause. The documentation is lacking as of now, but there are plans to improve it.
+[[Category: Development]]