Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.14 KB

Development.md

File metadata and controls

34 lines (24 loc) · 1.14 KB
Raw

Development Environment

Prerequisite

Node is required for local development. We recommend using a Node version manager (nvm for example) to ensure a stable development environment is used. Below are the required node / npm versions:

    "node": ">18.13.0",
    "npm": ">8.19.3"

Installation

In your working directory, open terminal and paste the following commands:

    git clone https://github.com/WebKit/Speedometer.git
    cd Speedometer
    npm install

Run Development Server

  1. In your terminal run: 
        PORT=8900 npm run dev # Passing the env var PORT is optional
  2. Open your browser of choice and navigate to http://127.0.0.1:8900

Local Server

Speedometer uses http-server, which is a static HTTP server. Meaning it does not provide hot-reloading. By default, the dev script disables caching and local changes can be viewed by simply refreshing your browser window. Additional options of the http-server can be found here.