https://github.com/joelanman/nixon

A framework to step through a website saving screenshots
https://github.com/joelanman/nixon

Last synced: about 1 month ago
JSON representation

A framework to step through a website saving screenshots

• Host: GitHub
• URL: https://github.com/joelanman/nixon
• Owner: joelanman
• Created: 2014-02-07T10:53:44.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-10-21T12:33:45.000Z (about 9 years ago)
• Last Synced: 2024-04-15T12:13:15.947Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 7.5 MB
• Stars: 3
• Watchers: 4
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Nixon

A framework to step through a website saving screenshots, based on [Horseman](https://github.com/johntitus/node-horseman).

## You need

* [Node.js](http://node.js)

* [PhantomJS](http://phantomjs.org) - version 2 or later

## Getting started

* [Download Nixon](https://github.com/joelanman/nixon/archive/master.zip)

In the terminal, change to Nixon directory and run:

* `npm install`

* `node nixon`

The example script will run , and screenshots will be saved into a 'screenshots' folder.

## Scripts

Make a copy of `example-script.js`, for example `blog.js`

You can now run this script:

`node nixon blog`

### Script options

#### screenshotPath

Type: String

Where your screenshots will be saved. Supports the following tags:

- **#** - screenshot number (zero padded: ## outputs 01, ### outputs 001)

- **script** - name of the script

- **size.width**

- **size.height**

- **size.crop** - will output "full" or "crop" depending on the size set (see `sizes`)

- **step.name**

For example: "screenshots/[script]/[size.width]/[#]-[step.name]"

### sizes

Type: Array

The screen sizes you would like to capture. If you'd like the screenshot cropped to the set height, add "crop" as the 3rd item in the array.

For example `[[800, 600], [1280, 1024, "crop"]]`.

### steps

Type: Array

An array of step objects for the script to carry out (see below).

## Steps

#### expectedUrl

Type: String (URL)

If the browser is not on the `expectedUrl` at the end of this step, Nixon will log a warning in the console.

#### js

Type: Function

This JavaScript function will be run in the browser before the screenshot is taken.

If `open` is also set, it will run before `js`.

#### name

Type: String

The name of the step is used in the filename when saving screenshots.

#### open

Type: String (URL)

The browser will open the URL set here.

If `js` is also set, it will run after `open`.

#### screenshot

Type: Boolean

Default: `true`

If this is set to `false`, a screenshot won't be taken for this step.