mbanyar033 / ga-dev-tools

A showcase of demos and tools built with the various Google Analytics APIs and Libraries.

Google Analytics Demos and Tools

A showcase of demos and tools built with the various Google Analytics APIs and Libraries. View the Site (https://ga-dev-tools.appspot.com)

Submitting Feedback / Reporting Bugs

For the Demos & Tools site

• You may report bugs by submitting an issue.
• You may also submit an issue to request a new demo or tool.

For the Google Analytics platform

• Documentation for all Google Analytics API, libraries and SDKs can be found on Google Analytics Developers.
• If you have questions, please refer to the getting help section of the developers site to find the best place to get your questions answered.

Building and Running the Site Locally

The Google Analytics demos and tools site runs on Google App Engine and is built with node.js. To run the site locally you'll need the following software installed on your system:

• Node.js (v6.0.0+)
• Google Cloud SDK (v132.0.0+, with dev_appserver.py in your PATH)
• pip
• GraphicsMagick (with gm in your PATH)

Once all dependencies are installed, follow these steps to build and run the site locally:

# Clone the repository.
git clone https://github.com/googleanalytics/ga-dev-tools.git
cd ga-dev-tools

# Install the build dependencies.
pip install -r requirements.txt -t python_modules
npm install

# Install the 'gcloud app Python Extensions' component
gcloud components install app-engine-python

# Build the site and run the local App Engine server.
npm start

If you're wanting to load any of the pages that require server-side authorization, you'll also need to create a service account, add the private JSON key to your project's root directory, and name it service-account-key.json. You can follow the instructions described in the Server-side Authorization demo for more details.

Now you should be able to load http://localhost:8080/ in your browser and see the site. (Note, the client ID associated with this project has the origin localhost:8080 whitelisted. If you load the site on another port, authentication may not work properly.)

If you're running App Engine on Windows or Mac, you can use the App Engine Launcher GUI to run the site as an alternative to running the above command.

Deploying the site

To deploy your changes to production, follow the steps described in the pervious section to install dependencies and then run the deploy npm script with the NODE_ENV environment variable set to "production":

NODE_ENV=production npm run deploy

If you wish to preview your changes prior to releasing them in production, run the stage npm script:

NODE_ENV=production npm run stage

When running the deploy or stage scripts, the App Engine version number is automatically generated for you. However, the version can be overridden by setting the APP_ENGINE_VERSION environment variable.

NODE_ENV=production APP_ENGINE_VERSION=feature-test npm run stage

Note: running the deploy or stage script requires permissions for their respective App Engine projects.