HTTPArchive / httparchive.org

The HTTP Archive website hosted on App Engine
https://httparchive.org
Apache License 2.0
336 stars 43 forks source link

HTTPArchive.org Web Server on App Engine

New and improved version of HTTP Archive. This replaces the legacy version, the source code for which is still available at HTTPArchive/legacy.httparchive.org.

Run Locally

Source

  1. If you don't have virtualenv, install it using pip.
sudo pip install virtualenv
  1. Create an isolated Python environment, and install dependencies:
virtualenv --python python3.12 .venv
source .venv/bin/activate
pip install -r requirements.txt
  1. Install the NPM dependencies:
npm install
  1. Initialize the Google Cloud CLI (this is necessary because the App Engine server uses Google Cloud APIs):
gcloud init
  1. Run the application:
npm run start

Note: Windows users may need to run npm run watch and python main.py separately.

  1. In your web browser, enter the following address: http://127.0.0.1:8080

Staging

To test changes on a GCP App Engine server without deploying to the production instance, use the staging app at https://httparchive-staging.appspot.com.

npm run stage

Deploy

To push changes live to the production instance, use the deployment script. Changes will be available on https://httparchive.org.

npm run deploy

Added new icons

We use Font Awesome icons but inline them directly in the code to save using the JavaScript library. To add, or change an icon, find one on the Font Awesome website and copy the path from the SVG tab and reference it by name in the reports.json and add the SVG path in the reports.html file as per the others. The width in the reports.json can be set based on display preferences.

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.