Skip to content

Latest commit

 

History

History
68 lines (37 loc) · 3.01 KB

README.md

File metadata and controls

68 lines (37 loc) · 3.01 KB
Raw

Introduction

This example demonstrates how to visualize your Particle Photon, P1, and Electron locator results using Node.js in a Google App Engine Flexible Environment and the Google Maps Javascript API. This sample also uses the Express web framework, Websockets, and the Particle Javascript API.

Run Locally

Setup

You will need to supply a Google Maps Javascript API key in order for the example to work properly. Follow the instructions at Maps Javascript API: Get API Key. Be sure to review and understand the terms of service.

Set the key in config.json using the map_api_key variable. The code will inject the API key into the web page so the Maps JS library loads properly. This key is not secured so be sure to add referrer restrictions to your key. Consult Best practices for securely using API keys for more information.

Heads up! This app will ask for permision to your location. It is attempting to center the map on your location.

Launch

  1. Install the Google Cloud SDK.

  2. Setup the gcloud tool. This provides authentication to Google Cloud APIs and services. Learn more from our Quickstart guides.

     gcloud init

  3. Acquire local credentials for autheticating with Google Cloud Platform APIs:

     gcloud beta auth application-default login

  4. Clone this repo:

     git clone https://github.com/kwnevarez/particle-device-locator

  5. Install depedencies using npm:

     npm install

  6. Run the sample with npm:

     npm start

  7. Visit the application at http://localhost:8080.

Run in the Cloud

Note: Secure WebSockets are currently not supported by App Engine Flexible Environment. WebSockets will only work if you load your page over HTTP (not HTTPS).

To use Secure WebSockets now, you can launch a VM on Google Compute Engine using a custom image where you have added SSL support for WebSockets.

Setup

Before you can run or deploy the sample, you will need to create a new firewall rule to allow traffic on port 50051. This port will be used for websocket connections. You can do this with the Google Cloud SDK with the following command:

gcloud compute firewall-rules create default-allow-websockets \
  --allow tcp:50051 \
  --target-tags websocket \
  --description "Allow websocket traffic on port 50051"

Deploy

  1. Use the Google Developers Console to create a project/app id. (App id and project id are identical.)

  2. Setup the gcloud tool, if you haven't already.

     gcloud init

  3. Use gcloud to deploy your app.

     gcloud app deploy

  4. Awesome! Your application is now live at http://YOUR_PROJECT_ID.appspot.com. <-- Do not use HTTPS, as noted above, websockets will not work.

This is a demo, not an official Google product.