Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 3.05 KB

developer_setup.md

File metadata and controls

84 lines (65 loc) · 3.05 KB
Raw

Developer Setup

Requirements:

and an internet connection to download dependencies expressed in gradle.

For production use, API Key authentication or user authentication is required to access the ArcGIS location services provided by the ArcGIS Maps SDK for Kotlin toolkit components. Sign up for an ArcGIS account here.

Get Started

Clone this project from github, and open it in Android Studio. Choose any of the templates, build and run it on a device or in an emulator.

Package structure

The top level folder structure looks like this

arcgis-maps-sdk-kotlin-toolkit
├── bom
├── build
├── doc
├── gradle
├── microapps
└── toolkit

The actual toolkit components are releasable libraries whose modules can be found in the toolkit folder.

toolkit
├── authentication
├── compass
├── featureforms
├── geoview-compose
├── indoors
└── template

These libraries have package names like com.arcgismaps.toolkit.authentication. Note that the template module is used internally and is not released.

For each toolkit component, there are one or more example apps in the microapps folder.

microapps
├── AuthenticationApp
├── CompassApp
├── FeatureFormsApp
├── FloorFilterApp
├── MapViewGeometryEditorApp
├── MapViewIdentifyApp
├── MapViewInsetsApp
├── MapViewLocationDisplayApp
├── MapViewSetViewpointApp
├── SceneViewAnalysisOverlayApp
├── SceneViewCameraControllerApp
├── SceneViewLightingOptionsApp
├── SceneViewSetViewpointApp
└── TemplateApp

These apps have package names like com.arcgismaps.toolkit.featureformsapp

Creating new toolkit components

To add a new toolkit component, use the "new component starter" script. It can be found at the top level of the repo.

================================================================================
Usage: new-component-starter.sh -n component-name

Description: generates a new toolkit component and microapp with the given name
 -n  the name of the new toolkit component
 -h        this help message
 ./new-component-starter.sh -n FloorFilter
================================================================================

This script will

  • copy the template toolkit component module, and the TemplateApp microapp into new modules with the name provided to the script.
  • update settings.gradle.kts to add these two new modules.

This script requires bash 4.0.