0c23462f5367cc6afc5275add4c29ab412af3f03
[yaffs-website] / jcalderonzumba / gastonjs / docs / index.md
1 # Welcome to GastonJS documentation
2 Creating web pages and ensuring that they behave as you want them to behave is something that a lot of projects try to solve, so let me explain you what this project is about:
3
4 * GastonJS allows you to use all the power [PhantomJS](http://phantomjs.org/) provides by implementing a simple command based HTTP API.
5 * GastonJS API allows you to implement a browser client on any programming language that can make HTTP requests.
6 * GastonJS gives you all the control, you are the one that will tell the browser what to do, similar to Selenium based tests.
7
8 ## Installation
9
10 GastonJS comes with a PHP built in client that allows you to control the browser and interact with it.
11
12 The objective of this document is not to teach you how to install [PhantomJS](http://phantomjs.org/) so please make sure you have a working installation of [PhantomJS](http://phantomjs.org/) before using GastonJS.
13
14 The recommended way to install GastonJS and the PHP built in client is through [Composer](https://getcomposer.org/):
15
16 ```bash
17 composer require jcalderonzumba/gastonjs
18 ```
19
20 Everything will be installed inside `vendor` folder, as with any composer package you can start using it by including the autoloading script in your PHP project.
21
22 ## Learn to control the Browser
23 * [GastonJS API](api/index.md)
24 * [PHP GastonJS Client](clients/php/index.md)
25
26 ## Special thanks
27 None of this work would have been possible without the awesome work done by the [Poltergeist team](https://github.com/teampoltergeist/poltergeist).
28
29 We fork their code and took it to another level, but the roots are still there and we want to acknowledge that.