codeforamerica / speedlify-cfa

A leader board of sites based on performance metrics.

Home Page:https://speedlify.codeforamerica.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Speedlify

Netlify deploy status

CRON GitHub Action

After you make a fast web site, keep it fast by measuring it over time. Read Use Speedlify to Continuously Measure Site Performance. Created by @zachleat.

  • Requires Node 12+
  • Each file in _data/sites/*.js is a category and contains a list of sites for comparison.

Run locally

npm install
npm run test-pages
npm run start

Update sites to run statistics on

Go to one of the JavaScript files in _data/sites and modify the urls field.

Netlify for deployments

You'll need a login and be added to the Netlify team account. There you see trigger a production deploy or monitor failed deploys. Current folks with access:

  • Lou Moore
  • Colt Borg

Automatic builds

This repo has a GitHub Action that automatically re-deploy the site with new data every Monday and Friday morning.


Notes

Can run directly on Netlify (including your tests) and will save the results to a Netlify build cache (via Netlify Build Plugins, see plugins/keep-data-cache/).

Speedlify will also save your data to /results.zip so that you can download later. Though this has proved to be unnecessary so far, it does serve as a fallback backup mechanism in case the Netlify cache is lost. Just look up your previous build URL and download the data to restore.

Known Limitations

  • If you change a URL to remove a redirect (to remove or add a www., moved domains, etc), you probably want to delete the old URL’s data otherwise you’ll have two entries in the results list.
  • When running on Netlify, a single category has a max limit on the number of sites it can test, upper bound on how many tests it can complete in the 15 minute Netlify build limit.
  • The same URL cannot be listed in two different categories (yet).

About

A leader board of sites based on performance metrics.

https://speedlify.codeforamerica.org/

License:MIT License


Languages

Language:JavaScript 51.5%Language:Nunjucks 31.0%Language:CSS 17.4%