Project Setup

This guide is made based off a basic application already made, to keep most of the code specific to the MapsIndoors SDK. So that we don't need to spend too much time modifying or implementing UI elements. If confident, you can start off by creating your own project, and just taking the context of the different steps of the getting started guide. A short setup of a React native application with MapsIndoors is described below.

Basic example

Using basic example​

Set Up Your Environment​

Read here how to set up your React Native development environment

Basic Example​

You can find the basic example to start from here: Basic example Follow the included README on how to get the project up and running.

Setup MapsIndoors​

To run MapsIndoors you need to insert a google API key inside your project.

Android:

Inside the project navigate to android/app/src/main/res/values/google_maps_api.xml and replace the INSERT_KEY_HERE with your google API key

iOS:

Inside the project navigate to ios/GettingStartedProject/AppDelegate.mm and replace the /*Your Google API key here*/ inside provideAPIKey with your Google API key

Manual setup

Manual setup​

Project creation​

Create a new React Native project by running the following command

npx react-native@latest init GettingStartedProject

Dependencies​

Start by installing the bindings for your preferred map provider. There is currently only support for using one of these packages at a time.

npm install @mapsindoors/react-native-maps-indoors-google-maps
# npm install @mapsindoors/react-native-maps-indoors-mapbox

The getting started project makes use of the following publicly available UI components. We recommend using them while following the getting started guide.

# Bottomsheet
npm install @gorhom/bottom-sheet@^4

# Navigation
npm install @react-navigation/native @react-navigation/native-stack
npm install react-native-screens react-native-safe-area-context

The above components make use of the following dependecies, if using React Native 0.59 or below you will also need to link them, you can read how to below.

# Dependencies
npm install react-native-reanimated react-native-gesture-handler

Please see the following links for additional steps needed for installing the dependencies: https://docs.swmansion.com/react-native-gesture-handler/docs/installation/ https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/installation/

Pod install​

After making changes to dependecies, especially those involving native code, you will need to run the following command from the ios folder of your project:

pod install

Alternatively you can install the npm package pod-install and then run the following command from anywhere within the project:

npx pod-install

Code complete example​

During the guide you can use this example to refer to your project, or just play around with the code inside: Getting started

Using Mapbox​

While the examples are using google maps, it is also possible to use Mapbox instead with only minor changes to the project.

To do this follow the getting started of this page MapsIndoors Mapbox and replace any imports from @mapsindoors/react-native-maps-indoors-google-maps to @mapsindoors/react-native-maps-indoors-mapbox after this you is done, you can follow the getting started guide without any changes.