Skip to content

4tech-wojtek/pagespeed-inslides

 
 

Repository files navigation

PageSpeed InSlides

✏️ Description:

The PageSpeed InSlides tool, which—as the name suggests (not a typo, think "PageSpeed, but in slides") —lifts the output from the PageSpeed Insights API and creates an interactive HTML5 slide deck for you, on the fly. The target audience is technical, for example, front-end engineers and webmasters, this is not meant as an introductory pitch deck. Also, the decks are designed for desktop, to be shown in full screen mode, ideally on a projector.

Please note: this is not an official Google product.

🖥 Screenshots:

Input form with various options:

Input Form

Slide examples:

Title Slide

Screenshot Slide

Waterfall Diagram Slide

Optimization Slide

📚 Instruction Manual:

The features of the PageSpeed InSlides tool are described in the manual (PDF).

🔥 Demo:

Navigate to this demo deck, then navigate in the slides with the arrow keys ⬅️ ➡️). Please note that this demo is not generated live, but an archived older version.

⚙️ Setup:

Get an API key and activate the necessary APIs in the Google Developer Console:

Then rename the dot_env file in the repository to .env and paste the API key in.

Now you are good to go and launch the tool via npm run start.

🔨 Usage:

Open the form at localhost:3000/ and simply enter a URL, optionally change any of the other fields.

As an alternative, the user interface is also accessible in form of a hackable URL 😎. Just replace the highlighted parts as explained below: http://localhost:3000/slides?screenshot=true&locale=en&strategy=mobile&url=https://blog.google/

  • &locale=en → Any of the language codes supported by the API.
  • &strategy=mobile → Either "desktop" or "mobile".
  • &url=https://blog.google/ → Any URL that is publicly available.
  • &screenshot=true → Whether or not to include a screenshot, either "true" or "false".
  • &filterThirdPartyResources=false → Whether or not to filter out many third-party resources, either "true" or "false".
  • &mobileFriendlyTest=false → Whether or not to run a mobile-friendly test, either "true" or "false".

📧 Contact:

Thomas Steiner (tomac@google.com)

📄 License:

Copyright 2017 Google

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

HTML5 Slide Deck Generator Tool Based on the PageSpeed Insights API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 56.4%
  • HTML 34.1%
  • CSS 6.6%
  • Shell 2.9%