README.md

HTTPArchive.org Website

Run Locally

This is an Astro-based web application for HTTPArchive.org.

1. Install the NPM dependencies:

   npm install

   (When switching from older branches before the Astro migration, npm ci is recommended over npm install to ensure a clean install of dependencies and clean out legacy packages).

2. Run the application:

   • Development mode (with live reload):

   npm run astro:dev

   In your web browser, open http://localhost:4321

   • Production build:

   npm run build

   • Build & run locally:

   npm run start

Linting

To run the GitHub Super-Linter locally using Docker:

• macOS / Linux:

  npm run lint:darwin:linux

• Windows (Command Prompt):

  npm run lint:win32

Staging

(Only available to maintainers)

To deploy and test changes on the staging channel:

npm run stage

Deploy

(Only available to maintainers)

To push changes live to production instance:

npm run deploy

Adding New Icons

We use Font Awesome icons but inline them directly in the SVG sprite to avoid using the JavaScript library. To add or change an icon, find one on the Font Awesome website, copy the path from the SVG tab, reference it by name in config/reports.json, and add the SVG <symbol> path in src/pages/reports/index.astro.

Third-party software licenses

HTTP Archive uses Highcharts. See their licensing terms for more info. HTTP Archive uses Font Awesome. See their licensing terms for more info.