Installation

Download

Go to our download page to get the latest stable version.

Unzipping the file will create a folder called joshfire-framework/ containing all the code of the framework, examples, raw documentation and build tools.

Sanity Check

Open the file examples/helloworld/index.html in your favorite browser, it should display a white page with "Hello World" written on it. If so, you're ready to jump into the tutorial.

If you do not see "Hello World", use one of our support channel to get help.

Advanced topics

Downloading the development version

If you're adventurous, you can either get the latest version of the Joshfire SDK as a tarball or a zip file, or clone the source from GitHub. Please, keep in mind that we do not provide support for this version.

Running the documentation locally

Our documentation is first compiled, then served via HTTP thanks to node and our own framework. You'll need:

All required node modules are listed in the package.json file located at the root of the framework. Just use npm install at the root to install dependencies.

Others dependencies

Depending on commands you're executing, you may need to install:

Also, some adapters need specific tools. Dependencies are detailed in each adapters page.

Launching tests

You'll need:

All required node modules are listed in the package.json file located at the root of the framework. Just use npm install at the root to install dependencies.

Then open your terminal, go to the joshfire/test/ repository and execute the following command:

  $ fab general

and

  $ fab selenium