Analyzes a webpage and detects **performance** or **front-end code quality** issues. ### Choose your way to use the tool:
The online tool (recommended)
http://yellowlab.tools
The CLI (Command Line Interface) - doc here
The Grunt task for devs or CI
Visit gmetais/grunt-yellowlabtools
The NPM 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 via [PhantomJS](http://phantomjs.org/) (a headless browser) 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 we are geeks, not businessmen. All we want is a ★ on GitHub, it will boost our motivation to add more awesome features!!! ![example dashboard screenshot](./doc/img/screenshot.png) ## Test your localhost You can use [ngrok](https://ngrok.com/), a tool that creates a secure tunnel between your localhost and the online tool (or the public API). You can also use the CLI or the Grunt tasks as they run on your machine. ## Install your own private instance If your project is not accessible from outside, or if you want to fork and improve the tool, you can build your own instance. The documentation is [here](https://github.com/gmetais/YellowLabTools/wiki/Install-your-private-server). ## Help needed! There are so many things left to do, **your help would be greatly appreciated**! Please report bugs, ask for evolutions and come code with me. ## License Please read the [license](LICENSE). Icons are the property of [IcoMoon.io](https://icomoon.io/) ## Author Gaël Métais. I'm a webperf freelance based in Paris. If you understand French, you can visit [my website](http://www.gaelmetais.com). ## Contributors - Achraf Ben Younes [achrafbenyounes](https://github.com/achrafbenyounes)