https://github.com/amio/pageshot

Pageshot as a service.
https://github.com/amio/pageshot

micro-service pageshot screenshot webpage

Last synced: 3 days ago
JSON representation

Pageshot as a service.

• Host: GitHub
• URL: https://github.com/amio/pageshot
• Owner: amio
• Archived: true
• Created: 2017-04-14T07:15:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-04T04:49:11.000Z (about 6 years ago)
• Last Synced: 2024-08-01T22:46:13.825Z (3 months ago)
• Topics: micro-service, pageshot, screenshot, webpage
• Language: JavaScript
• Homepage: https://shot.now.sh
• Size: 134 KB
• Stars: 47
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# pageshot [![][now-deploy-src]](#deploy)

Pageshot as a service.

## Usage

- __Web UI__: https://shot.now.sh

- __Endpoint__: https://shot.now.sh/shot

Examples:

- https://shot.now.sh/shot?url=https://google.com

- https://shot.now.sh/shot?url=https://github.com&full=true

Query Params:

- __`url`__: The webpage location. (required)

- __`width`__: Viewport width. (default: 1280)

- __`height`__: Viewport height. (default: 800)

- __`full`__: Full page screenshot. (default: false)

- __`dpr`__: Device pixel ratio. (default: 2)

## Deploy

- to [now.sh](https://zeit.co/now):

```

now amio/pageshot

```

- using [Dockerfile](Dockerfile):

```

docker pull amio/pageshot

```

- running locally (require Google Chrome installed):

```

npm start

```

## License

ISC © [Amio](https://github.com/amio)

[now-deploy-src]: https://badgen.net/badge/%E2%96%B2/$%20now%20amio%2Fpageshot/333