93 lines
3.5 KiB
Markdown
93 lines
3.5 KiB
Markdown
<img src="./doc/img/logo.png" alt="Yellow Lab Tools"></img>
|
|
|
|
Analyzes a webpage and detects **performance** or **front-end code quality** issues. Easy to launch, easy to understand, in-depth details.
|
|
|
|
|
|
#
|
|
|
|
<img src="./doc/img/commandment.png" alt="No website should go live without being tested with Yellow Lab Tools"></img>
|
|
|
|
<table>
|
|
<tr>
|
|
<td width="70%">
|
|
The <b>online tool</b> (recommended):
|
|
<a href="http://yellowlab.tools" target="_blank">http://yellowlab.tools</a>
|
|
</td>
|
|
<td width="30%">
|
|
<img src="./doc/img/YLT-animated.gif"></img>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="70%">
|
|
The <b>CLI</b> (Command Line Interface) - <a href="https://github.com/gmetais/YellowLabTools/wiki/Command-Line-Interface" target="_blank">Doc here</a>
|
|
</td>
|
|
<td width="30%">
|
|
<img src="./doc/img/YLT-cli-animated.gif"></img>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="70%">
|
|
The <b>Grunt task</b>: <a href="https://github.com/gmetais/grunt-yellowlabtools" traget="_blank">gmetais/grunt-yellowlabtools</a>
|
|
<br>For developers or Continuous Integration
|
|
</td>
|
|
<td width="30%">
|
|
<img src="./doc/img/grunt-logo.png"></img>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="70%">
|
|
The <b>NodeJS</b> package - <a href="https://github.com/gmetais/YellowLabTools/wiki/NodeJS-module" target="_blank">Doc here</a>
|
|
</td>
|
|
<td width="30%">
|
|
<img src="./doc/img/npm-logo.png"></img>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="70%">
|
|
The <b>public API</b> - <a href="https://github.com/gmetais/YellowLabTools/wiki/Public-API" target="_blank">Doc here</a>
|
|
<br>
|
|
Allows you to launch runs from any language
|
|
</td>
|
|
<td width="30%">
|
|
<img src="./doc/img/api-logo.png"></img>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
## 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!!!
|
|
|
|
|
|
|
|
|
|
## 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)
|
|
|