Create a New Project

You begin by creating an initial application. Throughout this tutorial, you will modify and extend that starter application to create a simple application which covers the basic features of this guide.

If you need help to create a new project use this official Flutter guide

Set Up Your Environment​

This guide explains how to start using a MapsIndoors map in your Flutter application using the MapsIndoors Flutter SDK.

You will need to download and install the flutter toolchain.

We recommend using Android Studio and Xcode for using this tutorial. Read how to set Android Studio up here: Installing Android Studio

If you do not have any devices, you can set up an emulator through Android Studio, or in Xcode.

If you already have an Android device, make sure to enable developer mode and USB debugging

To benefit from the guides, you will need basic knowledge about:

• Flutter Development

• Mobile Development

Set Up Your Project​

To get your project started follow these steps:

1. Create a new project by writing the following command in your terminal

flutter create --platforms ios,android getting_started_mapsindoors_flutter

This will create a new project targeting Android and iOS platforms.

1. Go to lib/main.dart and delete its contents, we will fill it up again during this guide.

If you want to see an example of how this guide will look when completed, you can find it on Github here.

Set Up MapsIndoors​

Google Maps​

To get started with your project add the latest MapsIndoors version to your pubspec.yaml, it can be found here.

mapsindoors_googlemaps: ^4.1.6 # replace with the latest version

Android

First you need to extend the allowed gradle repositories to allow the SDK to resolve correctly:

1. Navigate to the app's project level build.gradle.

2. add maven { url 'https://maven.mapsindoors.com/' } to allprojects/repositories after mavenCentral()

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://maven.mapsindoors.com/' }
    }
}

To get the underlying Google Map to work, you need to perform the following steps:

1. Navigate to android/app/src/main/res/value.

2. Create a file in this folder called google_maps_api_key.xml.

3. Copy and paste the below code snippet and replace YOUR_KEY_HERE with your Google Maps API key.

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="google_maps_key">YOUR_KEY_HERE</string>
</resources>

To ensure that the app is able to build properly after obfuscation, we need to add some proguard rules:

1. Navigate to android/app/proguard-rules.pro, create it if neccesary

2. Copy and paste the below code snippet

##---------------Begin: proguard configuration for MapsIndoors  ----------
-keep interface com.mapsindoors.core.** { *; }
-keep class com.mapsindoors.core.errors.** { *; }
-keepclassmembers class com.mapsindoors.core.models.** { <fields>; }
-keep class com.mapsindoors.core.MPDebugLog
##---------------End: proguard configuration for MapsIndoors  ----------

##---------------Begin: proguard configuration for Gson  ----------
# Gson uses generic type information stored in a class file when working with fields. Proguard
# removes such information by default, so configure it to keep all of it.

-keep class com.google.gson.* {*;}
-keepclassmembers class com.google.gson.* {*;}

-keepattributes Signature

# For using GSON @Expose annotation
-keepattributes *Annotation*

# Gson specific classes
-dontwarn sun.misc.**
#-keep class com.google.gson.stream.** { *; }

# Application classes that will be serialized/deserialized over Gson
-keep class com.google.gson.examples.android.model.** { <fields>; }

# Prevent proguard from stripping interface information from TypeAdapter, TypeAdapterFactory,
# JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)
-keep class * extends com.google.gson.TypeAdapter
-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer

# Prevent R8 from leaving Data object members always null
-keepclassmembers,allowobfuscation class * {
  @com.google.gson.annotations.SerializedName <fields>;
}

-keep class com.google.gson.reflect.TypeToken { *; }

# Retain generic signatures of TypeToken and its subclasses with R8 version 3.0 and higher.
-keep,allowobfuscation,allowshrinking class com.google.gson.reflect.TypeToken
-keep,allowobfuscation,allowshrinking class * extends com.google.gson.reflect.TypeToken

##---------------End: proguard configuration for Gson  ----------

iOS

Mapbox​

To get started with your project add the latest MapsIndoors version to your pubspec.yaml, it can be found here.

mapsindoors_mapbox: ^4.1.6 # replace with the latest version

Android

First you need to extend the allowed gradle repositories to allow the SDK to resolve correctly:

1. Navigate to the app's project level build.gradle.

2. Add maven { url 'https://maven.mapsindoors.com/' } to allprojects/repositories after mavenCentral()

3. Add mapbox to repositories like in the example below:

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://maven.mapsindoors.com/' }
    }
    maven {
        url 'https://api.mapbox.com/downloads/v2/releases/maven'
        authentication {
            basic(BasicAuthentication)
        }
        credentials {
            // Do not change the username below.
            // This should always be `mapbox` (not your username).
            username = "mapbox"
            // Use the secret token you stored in gradle.properties as the password
            password = project.properties['MAPBOX_DOWNLOADS_TOKEN'] ?: ""
        }
    }
}

1. Add your mapbox download token to gradle.properties

MAPBOX_DOWNLOADS_TOKEN=YOUR_DOWNLOAD_TOKEN

To get the underlying Mapbox Map to work, you need to perform the following steps:

1. Navigate to android/app/src/main/res/value.

2. Create a file in this folder called mapbox_api_key.xml.

3. Copy and paste the below code snippet and replace YOUR_KEY_HERE with your Mapbox keys.

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="mapbox_api_key" translatable="false">YOUR_KEY_HERE</string>
    <string name="mapbox_access_token" translatable="false">YOUR_KEY_HERE</string>
</resources>

To ensure that the app is able to build properly after obfuscation, we need to add some proguard rules:

1. Navigate to android/app/proguard-rules.pro, create it if neccesary

2. Copy and paste the below code snippet

##---------------Begin: proguard configuration for MapsIndoors  ----------
-keep interface com.mapsindoors.core.** { *; }
-keep class com.mapsindoors.core.errors.** { *; }
-keepclassmembers class com.mapsindoors.core.models.** { <fields>; }
-keep class com.mapsindoors.core.MPDebugLog
##---------------End: proguard configuration for MapsIndoors  ----------

##---------------Begin: proguard configuration for Gson  ----------
# Gson uses generic type information stored in a class file when working with fields. Proguard
# removes such information by default, so configure it to keep all of it.

-keep class com.google.gson.* {*;}
-keepclassmembers class com.google.gson.* {*;}

-keepattributes Signature

# For using GSON @Expose annotation
-keepattributes *Annotation*

# Gson specific classes
-dontwarn sun.misc.**
#-keep class com.google.gson.stream.** { *; }

# Application classes that will be serialized/deserialized over Gson
-keep class com.google.gson.examples.android.model.** { <fields>; }

# Prevent proguard from stripping interface information from TypeAdapter, TypeAdapterFactory,
# JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)
-keep class * extends com.google.gson.TypeAdapter
-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer

# Prevent R8 from leaving Data object members always null
-keepclassmembers,allowobfuscation class * {
  @com.google.gson.annotations.SerializedName <fields>;
}

-keep class com.google.gson.reflect.TypeToken { *; }

# Retain generic signatures of TypeToken and its subclasses with R8 version 3.0 and higher.
-keep,allowobfuscation,allowshrinking class com.google.gson.reflect.TypeToken
-keep,allowobfuscation,allowshrinking class * extends com.google.gson.reflect.TypeToken

##---------------End: proguard configuration for Gson  ----------

iOS