Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 974 Bytes

README.md

File metadata and controls

52 lines (34 loc) · 974 Bytes

Browserazzi Build Status

A paparazzi for your browser that takes screenshots of websites given a URL.

Try the demo here.

Installation

To install cd to the project directory and run:

$ npm install

To run the app you'll need to create a .env file with a SECRET environment variable.

$ touch .env
$ echo "SECRET=$(md5 <<< 'Some secret value')" >> .env

Getting Started

You can run the app with:

$ node app.js

If you wish to run the app on a different port you can do so with:

$ node app.js --port 4000
# or
$ node app.js --p 4000

Running tests

If you wish to run the tests run them with:

$ npm test

TODO [Unreleased]

  • Restructure application with genr8
  • Upgrade package versions
  • Refactor to ES6 syntax
  • Add API documentation