Skip to content

A collection of performance tools which allow a js developer to reliably model and monitor a webapp

License

Notifications You must be signed in to change notification settings

unlikelyzero/js-perf-toolkit

Repository files navigation


js-perf-toolkit

A collection of (Open Source) performance tools which allow a js developer to reliably model and monitor a webapp.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact
  7. Acknowledgements

About The Project

A collection of (Open Source) performance tools which allow a js developer to reliably model and monitor a webapp. At the moment, most of the focus is on the playwright component.

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation

This installation is split into two components: the playwright local installation and the full stack of performance Infrastructure.

playwright local

  1. Clone this repo
    git clone https://github.com/unlikelyzero/js-perf-toolkit.git
  2. Install nvm. https://github.com/nvm-sh/nvm/
  3. npm install the ./playwright repo
    cd playwright
    nvm use 14
    npm install
  4. install playwright browsers
    npx playwright install
  5. run a basic test
    npm run test:local:basic

Docker Infrastructure

  1. Clone the repo
    git clone https://github.com/unlikelyzero/js-perf-toolkit.git
  2. Start the monitoring containers (except browserless)
    docker compose up -d
    
  3. Verify that the following webservers are up:
    localhost:9090
    localhost:8086
    localhost:8089
    localhost:3006
    
  4. Start the browserless container
    docker compose -f ./browserless.dc.yaml up -d browserless
    
  5. Verify that the following webserver is up
    localhost:3003
    

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

John Hill - [Email on https://github.com/unlikelyzero]

Project Link: https://github.com/unlikelyzero/js-perf-toolkit

Acknowledgements

Sources

About

A collection of performance tools which allow a js developer to reliably model and monitor a webapp

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published