File: Development.md

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (34 lines) | stat: -rw-r--r-- 1,114 bytes parent folder | download | duplicates (25) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# Development Environment

## Prerequisite

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

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

## Installation

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

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

## Run Development Server

1. In your terminal run:
    ```sh
        npm run dev
    ```
2. Open your browser of choice and navigate to [http://127.0.0.1:7000](http://127.0.0.1:7000)

## Local Server

Speedometer uses [http-server](https://github.com/http-party/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](https://github.com/http-party/http-server#available-options).