~~Title: Build release~~
~~NOTRANS~~
~~NOPDF~~

======Build script======

The build script is available in the **creator** directory. The script is [[https://ant.apache.org/|Apache ANT]] based and it's a simple XML file. It defines several build commands. The default command (start.complete) creates output for iOS, Android and Web deployment.

The iOS build command requires macOS but won't fail if your system is not macOS.

=====Requirements=====

Java Runtime environment > 8.0

=====Commands=====

====Complete (start.complete)====

  cd creator
  ./build.sh
  
or

  cd creator
  build.cmd
  
====iOS (start.ios)====

  cd creator
  ./build.sh start.ios

====Android (start.android)====

  cd creator
  ./build.sh start.android
  
For app signing, a keystore will be used. Our build process needs a file with the name **key.properties**. Put this file in the folder  
//<project>/creator/android//, together with your keystore. It's also possible to put the file in your android project folder. We support both locations.

The **key.properties** will be used to read all relevant information and should contain:

<code properties>
keyAlias=<alias>
keyPassword=<keypassword>

storeFile=<keystore_filename>
storePassword=<storepassword>
</code>

To support signing, it's important to change your gradle build in folder //<project>/android/app/build.gradle//. We need following changes:

<code javascript>
def keystoreProperties = new Properties()
def keystorePropertiesFile = rootProject.file('key.properties')

if (keystorePropertiesFile.exists()) {
    keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
} else {
    keystorePropertiesFile = rootProject.file('../creator/android/key.properties')

    if (keystorePropertiesFile.exists()) {
        keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
    } else {
        keystorePropertiesFile = rootProject.file('../../../android/key.properties')

        if (keystorePropertiesFile.exists()) {
            keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
        }
    }
}
</code>

and

<code javascript>
signingConfigs {
    release {
        keyAlias keystoreProperties['keyAlias']
        keyPassword keystoreProperties['keyPassword']
        storeFile keystoreProperties['storeFile'] ? rootProject.file(keystorePropertiesFile.getParent() + '/' + keystoreProperties['storeFile']) : null
        storePassword keystoreProperties['storePassword']
    }
}

buildTypes {
    release {
        signingConfig signingConfigs.release
    }
}
</code>

A [[https://github.com/sibvisions/flutter_jvx/blob/main/android/app/build.gradle|complete build file]] is available in our project.

====Web (start.web)====

  cd creator
  ./build.sh start.web

The results will be available in 

  creator/build/install
  
directory.

=====Updates=====

To get the latest build script, simply call

  cd creator
  ./update.sh
  
The latest [[https://raw.githubusercontent.com/sibvisions/flutterclient/main/creator/build.xml|build.xml]] will be saved in the creator directory.