Skip to content

Commit 4863d15

Browse files
authored
Update Readme to reference use of local package (#2)
Update Readme to reference use of local package
2 parents 653d875 + cc522e1 commit 4863d15

File tree

4 files changed

+52
-73
lines changed

4 files changed

+52
-73
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ app.*.map.json
4646
/android/app/profile
4747
/android/app/release
4848

49+
/ios/Podfile.lock
4950

5051
env.json
5152

README.md

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,43 @@
22

33
This repository contains Flutter sample code demonstrating the capabilities of ArcGIS Maps SDK for Flutter and how to use them in your own app. This SDK enables development of cross-platform GIS apps for mobile devices running iOS and Android.
44

5+
## Run the samples using the Beta package of ArcGIS Maps SDK for Flutter
6+
7+
Visit [earlyadopter.esri.com](https://earlyadopter.esri.com/) and download the ArcGIS Maps SDK for Flutter package. Follow the instructions to unpack it.
8+
9+
Clone or download this repository into the same parent directory as the `arcgis_maps_package`. Your file structure should be:
10+
11+
```
12+
parent_directory
13+
|
14+
|__ arcgis-maps-sdk-flutter-samples
15+
|
16+
|__ arcgis_maps_package
17+
```
18+
19+
Navigate to the `arcgis-maps-sdk-flutter-samples` directory.
20+
21+
```
22+
cd arcgis-maps-sdk-flutter-samples
23+
```
24+
25+
Use `flutter pub upgrade` to configure the dependencies.
26+
27+
```
28+
flutter pub upgrade
29+
```
30+
31+
Install arcgis_maps_core.
32+
33+
```
34+
dart run arcgis_maps install
35+
```
36+
37+
Now you are ready to run the samples app!
38+
539
## Running the Samples app
640

7-
The app can be run on an iOS or Android simulator or device.
41+
The app can be run on an iOS or Android simulator or device. Note: you will need to configure an API key to take full advantage of the samples in the app. See [Configuring API Keys](#configuring-api-keys).
842

943
- Open the flutter project in VSCode
1044
- Ensure a simulator is running or a device is connected to your development machine
@@ -26,24 +60,34 @@ Individual samples can also be run on an iOS or Android simulator or device.
2660

2761
## Configuring API Keys
2862

29-
To fully take advantage of the samples in the app, you will need to generate an API Key.
63+
To take full advantage of the samples in the app, you will need to generate an API Key.
3064

31-
- Log into your developer account at the [ArcGIS Developers](https://developers.arcgis.com/)
65+
- Log into your developer account at [ArcGIS Developers](https://developers.arcgis.com/)
3266
- If you do not have an account, [create one](https://developers.arcgis.com/sign-up/)
3367
- Go to the "API keys" tab
3468
- Click the "New API Key" button and provide a Title and Description
3569
- Set Location Service scopes to add or remove key capabilities
3670

37-
Add the new API Key directly to [main.dart](lib/main.dart) or create an environment JSON file that can be loaded with the `--dart-define-from-file` `flutter run` command line argument.
71+
Add the new API Key directly to [main.dart](lib/main.dart) or create an environment JSON file that can be loaded with the `--dart-define-from-file` `flutter run` command line argument.
72+
73+
The JSON file itself should be of the format:
74+
75+
```
76+
{
77+
"API_KEY": "your_api_key_here"
78+
}
79+
```
80+
81+
To run using the JSON file to define your API key:
3882

3983
```
4084
flutter run --dart-define-from-file=path/to/json/file.json
4185
```
4286

43-
or to run an individual sample:
87+
Or to run an individual sample:
4488

4589
```
46-
flutter run lib/src/samples/display_map.dart --dart-define-from-file=path/to/json/file.json
90+
flutter run lib/src/samples/display_map.dart --dart-define-from-file=path/to/json/file.json
4791
```
4892

4993
## Licensing

ios/Podfile.lock

Lines changed: 0 additions & 66 deletions
This file was deleted.

pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ dependencies:
1212
sdk: flutter
1313

1414
arcgis_maps:
15-
path: ../arcgis_maps
15+
path: ../arcgis_maps_package
1616

1717
async: ^2.11.0
1818
path_provider: ^2.1.2

0 commit comments

Comments
 (0)