The Maps App for iOS shows how a robust application can be built around the ArcGIS Platform using the ArcGIS Runtime SDK for iOS and Swift. It demonstrates best practices around some simple but key functionality of the ArcGIS Runtime. You can use the Maps App as is, or extend it to meet your specific needs.
Read the docs for a detailed explanation of the application, including its architecture and how it leverages the ArcGIS platform, as well as how you can begin using the app right away.
The project also demonstrates some patterns for building real-world apps around the ArcGIS Runtime SDK.
Make sure you've installed Xcode and the ArcGIS Runtime SDK for iOS and that they meet these requirements.
Fork the Maps App repo
Once you have forked the repo, you can make a clone and open maps-app-ios.xcodeproj
in Xcode.
cd
into the maps-app-ios
folderIf you make changes in the fork and would like to sync those changes with the upstream repository, you must first configure the remote. This will be required when you have created local branches and would like to make a pull request to your upstream branch.
git remote -v
to list the current configured remote repo for your fork.git remote add upstream https://github.com/Esri/maps-app-ios.git
to specify new remote upstream repository that will be synced with the fork. You can type git remote -v
to verify the new upstream.If there are changes made in the Original repository, you can sync the fork to keep it updated with upstream repository.
git fetch upstream
to fetch the commits from the upstream repositorygit checkout master
to checkout your fork's local master branch.git merge upstream/master
to sync your local master
branch with upstream/master
. Note: Your local changes will be retained and your fork's master branch will be in sync with the upstream repository.The app can be run as is, but it's recommended you do some configuration to set up OAuth to be relevant to your users (certainly it should not be deployed without these changes):
For OAuth configuration, create a new Application in your ArcGIS Portal to obtain a Client ID
and configure a Redirect URL
. The Client ID configures the ArcGIS Runtime to show your users, during the log in process, that the application was built by you and can be trusted. The Redirect URL configures the OAuth process to then return to your app once authentication is complete.
my-maps-app://auth
. We will use this URL in the Configuring the project section below. Configure Redirect URL
maps-app-ios
target's Info
panel and expand the AGSConfiguration
dictionary (see steps 1-4 in the screenshot below).AppURLScheme
value to match the Redirect URL scheme (the part before the ://
, e.g. my-maps-app
) configured in "Register an Application" above. Note how the AppURLScheme
and AuthURLPath
combine to construct the Redirect URL. com.my-org.my-maps-app
).://
, e.g. my-maps-app
) configured in "Register an Application" above.Configure Client ID
maps-app-ios/Maps App
to reveal a file named AppSettings.swift
.AppSettings.swift
set the value of the static variable clientID
to the application's Client ID noted above.Remove the Licensed for Developer Use Only watermark on the map view by setting the Runtime License Key.
This step is optional during development, but required for deployment.
Show my ArcGIS Runtime Lite license key
at the top-right of the Licensing Your ArcGIS Runtime App page (you must be logged in).AppSettings.swift
, the same file used to configure your applications client id.licenseKey
to the value from step 1.Learn more about ArcGIS open source apps here.
Note: Starting from the 100.8 release, the ArcGIS Runtime SDK for iOS uses Apple's Metal framework to display maps and scenes. However, Xcode does not support Metal based rendering in any version of iOS simulator on macOS Mojave. If you are developing map or scene based apps in these environments, you will need test and debug them on a physical device instead of the simulator.
Note: The 100.10 release of the ArcGIS Runtime SDK for iOS replaces the installed "fat framework" ArcGIS.framework
with a new binary framework ArcGIS.xcframework
. It also changes the location of the installed framework file and removes the need for the strip-frameworks.sh
Build Phase. These changes have been incorporated in the lastest release of the Maps App for iOS.
Anyone and everyone is welcome to contribute. We do accept pull requests.
Generating table of contents for documents in this repository was performed using the MDTOC package for Atom.
Copyright 2017 Esri
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
A copy of the license is available in the repository's LICENSE file.
For information about licensing your deployed app, see License your app.
Some great open source components are available out there for iOS developers. The following have been used in this project, with much gratitude to their authors.