Skip to content

Commit 956e999

Browse files
committed
docs(examples-readmse): add note for windows users about cross env and npmrc setup
1 parent eeac55d commit 956e999

File tree

14 files changed

+42
-0
lines changed

14 files changed

+42
-0
lines changed

examples/basic-google-map/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show a basic Google Map.

examples/directions-service/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show a Google Map with a route from Berlin to Munich, retrieved from directions.

examples/distance-matrix-service/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show Google Map with a origin and different destinations. A side panel will show the different durations and distances to the destinations.

examples/elevation-service/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ To see the examples it is needed to add an `.env` file with a [Google Maps API k
2727

2828
An example can be found in `.env.example`.
2929

30+
**NOTE FOR WINDOWS USERS**:
31+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
32+
3033
## Output
3134

3235
The project will start at [localhost:1234](http://localhost:1234) and show an infowindow on a map asking to click somewhere on the map to see the elevation of that position.

examples/geocoding-service/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show a Google Map where the user can click on the map and the coordinates will be reversed geocoded into a human readable address.

examples/google-map-with-markers/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show a Google Map with markers.

examples/max-zoom-service/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ To see the examples it is needed to add an `.env` file with a [Google Maps API k
2727

2828
An example can be found in `.env.example`.
2929

30+
**NOTE FOR WINDOWS USERS**:
31+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
32+
3033
## Output
3134

3235
The project will start at [localhost:1234](http://localhost:1234) and show an infowindow on a map asking to click somewhere on the map to see the max zoom for map type imagery for a position.

examples/multiple-google-maps/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show multiple Google Map instances.

examples/places-autocomplete-service/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show a map with an input field and an autocomplete functionality.

examples/places-autocomplete-widget/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show a map with an input field and an autocomplete functionality.

examples/places-service-with-element/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show a list of restaurants and their ratings close to Istanbul. Information is retrieved from Places Service.

examples/places-service/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ GOOGLE_MAPS_API_KEY="<YOUR API KEY HERE>"
2929

3030
An example can be found in `.env.example`.
3131

32+
**NOTE FOR WINDOWS USERS**:
33+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
34+
3235
## Output
3336

3437
The project will start at [localhost:1234](http://localhost:1234) and show a Google Map that highlights all nearby Cafes to the central station in Hamburg, and their opening hours. Information is retrieved from Places Service.

examples/street-view-panorama-map/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ To see the examples it is needed to add an `.env` file with a [Google Maps API k
2727

2828
An example can be found in `.env.example`.
2929

30+
**NOTE FOR WINDOWS USERS**:
31+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
32+
3033
## Output
3134

3235
The project will start at [localhost:1234](http://localhost:1234) and show a map with street view.

examples/street-view-panorama-with-element/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ To see the examples it is needed to add an `.env` file with a [Google Maps API k
2727

2828
An example can be found in `.env.example`.
2929

30+
**NOTE FOR WINDOWS USERS**:
31+
We are using [cross-env](https://github.com/kentcdodds/cross-env) for environment variables to work on all platforms. There is an issue that `npm` uses `cmd` by default. The workaround is to add `script-shell` to `powershell` in your `.npmrc`. Please follow [this setup](https://github.com/kentcdodds/cross-env/issues/192#issuecomment-513341729) to make it work.
32+
3033
## Output
3134

3235
The project will start at [localhost:1234](http://localhost:1234) and show a map with a street view element at the right bottom.

0 commit comments

Comments
 (0)