Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.69 KB

getting-started-local.md

File metadata and controls

18 lines (14 loc) · 1.69 KB
Raw

Getting Started on Local machine / Virtual Machine

This method is best if you want to test/verify private websites like acceptance test environments, it is also best/fastest when wanting to contribute with new tests, translations or other stuff.

How to setup

  • Download and install Python 3.8 (or later) if you don't have it installed already.
  • Fork webperf-core repository or download webperf-core to your machine.
  • Copy SAMPLE-config.py to new file named config.py, read more about config.py here
  • Open the Terminal (Macos & Linux) or Command Prompt (Windows).
  • Navigate to where you downloaded (and unpacked) the source code. If you don’t know how to navigate in Terminal/CMD, read the Windows guide or under Step 5 for Mac / Linux.
  • Update Python Package manager by typing following and hit Enter: python -m pip install --upgrade pip
  • Install required Python packages by typing following and hit Enter: pip install -r requirements.txt
  • Validate that core functionality is working by typing following and hit Enter python default -h
  • If the output looks something like example in options and arguments you have successfully setup the general parts of webperf-core.
  • Please look at/return to the specific test you want to run to make sure it doesn't require more steps.