https://github.com/YellowLabTools/YellowLabTools

WebPerf and front-end quality testing tool
https://github.com/YellowLabTools/YellowLabTools

Last synced: 7 days ago
JSON representation

WebPerf and front-end quality testing tool

• Host: GitHub
• URL: https://github.com/YellowLabTools/YellowLabTools
• Owner: YellowLabTools
• License: gpl-2.0
• Created: 2014-08-01T14:24:43.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-02-21T10:29:28.000Z (9 months ago)
• Last Synced: 2024-10-29T11:34:41.517Z (10 days ago)
• Language: JavaScript
• Homepage: https://yellowlab.tools
• Size: 2.96 MB
• Stars: 2,377
• Watchers: 53
• Forks: 121
• Open Issues: 72
• Metadata Files:
  • Readme: README.md
  • Funding: FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - YellowLabTools/YellowLabTools - WebPerf and front-end quality testing tool (JavaScript)

README

        


Analyzes a webpage and detects **performance** or **front-end code quality** issues. Free, easy to launch, easy to understand, in-depth details.

#  



    

        

            The online tool (recommended): 

            https://yellowlab.tools

        

        

            

        

    

    

        

            The Docker image - ousamabenyounes/docker-yellowlabtools

            


            Your own private instance of Yellow Lab Tools, on your computer.

        

        

            

        

    

    

        

            The CLI (Command Line Interface) - Doc here

        

        

            

        

    

    

        

            The NodeJS package - Doc here

        

        

            

        

    

    

        

            The public API - Doc here

            


            Allows you to launch runs from any language

        

        

            

        

    

## How it works

The tool loads the given URL and collects various metrics and statistics with the help of [Phantomas](https://github.com/macbre/phantomas). These metrics are then categorized and transformed into scores. It also gives in-depth details so developpers can fix the detected issues.

By the way, it's free because I am a geek, not businessmen. In return, you can add a ★ on GitHub, it will boost my motivation to add more awesome features!!!

![example dashboard screenshot](./doc/img/screenshot.png)

## Install your own private instance

If your project is not accessible from outside or if you want to test your localhost, you might want to run your own instance of Yellow Lab Tools.

The classical way is to clone the YLT server's GitHub repository and run it on Linux or MacOS. The documentation is [here](https://github.com/YellowLabTools/YellowLabTools/wiki/Install-your-private-server).

The new recommended solution is to run Yellow Lab Tools inside a Docker virtual machine. My friend Ousama Ben Younes maintains [this ready-to-use Docker image based on Alpine](https://github.com/ousamabenyounes/docker-yellowlabtools)).

## Author

Gaël Métais. I'm a webperf freelance. Follow me on Twitter [@gaelmetais](https://twitter.com/gaelmetais), I tweet about Web Performances, Front-end and new versions of Yellow Lab Tools!



I can also help your company about Web Performances, visit [my website](https://www.gaelmetais.com).

## Contributors

- Achraf Ben Younes [achrafbenyounes](https://github.com/achrafbenyounes)

- Km [camlafit](https://github.com/camlafit)

- Vincent L. [magikcypress](https://github.com/magikcypress)

- Ousama Ben Younes [ousamabenyounes](https://github.com/ousamabenyounes)