|
|
@@ -1,6 +1,6 @@
|
|
|
# Yellow Lab Tools
|
|
|
|
|
|
-Online tool designed to help Front-End developers optimize their website
|
|
|
+Online tool that lets you test a webpage and detects **performance** and **front-end code quality** issues.
|
|
|
|
|
|
[](https://gemnasium.com/gmetais/YellowLabTools) [](https://travis-ci.org/gmetais/YellowLabTools)
|
|
|
|
|
|
@@ -10,21 +10,35 @@ Online tool designed to help Front-End developers optimize their website
|
|
|
|
|
|
## How it works
|
|
|
|
|
|
-The tool is based on the fabulous [Phantomas](https://github.com/macbre/phantomas) by Maciej Brencz, that loads a page and collects many web performance metrics.
|
|
|
-I rewrote some modules to deeper analyze Javascript interactions with the DOM (especially with jQuery).
|
|
|
-And then it is wrapped inside a small NodeJS server to get an interface (inspired by my favorite tool: [WebPageTest](http://www.webpagetest.org/)).
|
|
|
+The tool loads the given URL via [PhantomasJS](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 categorized and transformed into scores. It also gives in-depth details so developpers can correct the detected issues.
|
|
|
|
|
|
-**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.**
|
|
|
+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!!!
|
|
|
|
|
|
|
|
|
-## Help needed
|
|
|
+## Different ways to use YLT
|
|
|
+
|
|
|
+#### Web interface
|
|
|
+This is the best way to discover the tool: [http://yellowlab.tools](http://yellowlab.tools).
|
|
|
+Please note the server is hosted in Baltimore, USA.
|
|
|
|
|
|
-I'm currently looking for help in correcting the english wordings in the tool, as it is not my native language.
|
|
|
+#### Command Line
|
|
|
+Might be useful if you want to build an automation tool. The documentation is [here](https://github.com/gmetais/YellowLabTools/wiki/Command-Line-Interface).
|
|
|
|
|
|
+#### NodeJS module
|
|
|
+Can be used to build automation tools in NodeJS. The documentation is [here](https://github.com/gmetais/YellowLabTools/wiki/NodeJS-module).
|
|
|
|
|
|
-## Install your own instance
|
|
|
+#### Public API
|
|
|
+Hosted on our http://yellowlab.tools server, it is a RESTful API that allows you to launch distant tests. The documentation is [here](https://github.com/gmetais/YellowLabTools/wiki/Public-API).
|
|
|
|
|
|
-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-own-instance).
|
|
|
+
|
|
|
+## 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
|
|
|
@@ -38,4 +52,5 @@ Gaël Métais. I'm a webperf freelance based in Paris. If you understand french,
|
|
|
|
|
|
|
|
|
## Contributors
|
|
|
-- [achrafbenyounes](https://github.com/achrafbenyounes)
|
|
|
+- [achrafbenyounes](https://github.com/achrafbenyounes)
|
|
|
+
|
Gaël Métais