maverick/flex-template-web
1
0
Fork 0
mirror of https://github.com/kingomarnajjar/flex-template-web.git synced 2026-07-26 06:47:17 +10:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document adding a Google Maps API key

Browse source
This commit is contained in:
Kimmo Puputti 2018-01-18 13:36:27 +02:00
parent db4023e9be
commit 46c7e34d27
2 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/README.md
View file

@ -18,3 +18,4 @@ Documentation for specific topics can be found in the following files:
* [i18n](i18n.md)
* [Colors and icons](colors-and-icons.md)
* [Starting a new customisation project](starting-a-new-customisation-project.md)
* [Google Maps](google-maps.md)

28
docs/google-maps.md Normal file
View file

@ -0,0 +1,28 @@
# Google Maps
Starter App uses the Google Maps API for showing a map and in searching locations in the search
autocompletion. This document describes how to setup the API key for the API requests to work
properly.
## Generate a Google Maps API key
Go to the
[Google Maps JavaScript API V3 Reference](https://developers.google.com/maps/documentation/javascript/reference),
click on the "GET A KEY" button in the top bar, and follow the instructions. You can copy the given
key to your application now.
## Enable Google Places API Web Service
Follow the instructions in the
[Getting started](https://developers.google.com/maps/documentation/javascript/places#GetStarted)
section of the Places library documentation to enable using the Google Places API Web Service.
## Setup the application to use the API key
The application uses the `REACT_APP_GOOGLE_MAPS_API_KEY` environment variable for the key value. For
local development, you can add the variable in the Gitignored `.env.development.local` file in the
project root:
```
REACT_APP_GOOGLE_MAPS_API_KEY=my-key-here
```