{"id":22403335,"url":"https://github.com/springload/screenshotron","last_synced_at":"2025-07-31T16:31:54.994Z","repository":{"id":57153897,"uuid":"69576311","full_name":"springload/screenshotron","owner":"springload","description":"The most aptly-named way to take screenshots of pages with Electron.","archived":false,"fork":false,"pushed_at":"2017-01-27T15:04:14.000Z","size":17,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-08-10T23:23:42.245Z","etag":null,"topics":["electron","engine","screenshot"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/springload.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-29T14:36:48.000Z","updated_at":"2020-03-27T17:26:43.000Z","dependencies_parsed_at":"2022-08-24T08:10:06.471Z","dependency_job_id":null,"html_url":"https://github.com/springload/screenshotron","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springload%2Fscreenshotron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springload%2Fscreenshotron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springload%2Fscreenshotron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/springload%2Fscreenshotron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/springload","download_url":"https://codeload.github.com/springload/screenshotron/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228267806,"owners_count":17893841,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","engine","screenshot"],"created_at":"2024-12-05T09:16:49.723Z","updated_at":"2024-12-05T09:16:51.167Z","avatar_url":"https://github.com/springload.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"screenshotron [![npm](https://img.shields.io/npm/v/screenshotron.svg?style=flat-square)](https://www.npmjs.com/package/screenshotron) [![Build Status](https://img.shields.io/travis/springload/screenshotron.svg?style=flat-square)](https://travis-ci.org/springload/screenshotron) [![dependency Status](https://img.shields.io/david/springload/screenshotron.svg?style=flat-square)](https://david-dm.org/springload/screenshotron) [![devDependency Status](https://img.shields.io/david/dev/springload/screenshotron.svg?style=flat-square)](https://david-dm.org/springload/screenshotron)\n==========\n\n\u003e The most aptly-named way to take screenshots of pages with [Electron](http://electron.atom.io/).\n\n:warning: This is alpha software, no matter which tool you are using always check the screenshots yourself.\n\n## Installation\n\nRequires Node 6+. From the command line, run\n\n```sh\nnpm install -g screenshotron\n```\n\n## Usage\n\nFrom the command line, run\n\n```sh\nscreenshotron example.com\n✔ Generated 1 screenshot from 1 url and 1 size\n# With a specific time to wait for before screenshotroning\nscreenshotron --delay 3000 example.com bananas.com\n✔ Generated 2 screenshots from 2 urls and 1 size\n```\n\n## Contributing\n\n\u003e You first need to clone the project on your computer, and to install [Node](https://nodejs.org). This project uses [nvm](https://github.com/creationix/nvm) to execute a specific node version.\n\nInstall the project with:\n\n```sh\ngit clone git@github.com:springload/screenshotron.git\ncd screenshotron\nnvm install\nnpm install\nnpm install -g eslint babel-eslint eslint-config-airbnb\n./.githooks/deploy\n```\n\nTo run the tests:\n\n```sh\nnpm run test\n```\n\nTo release a new version:\n\n```sh\nnpm version minor -m \"Release %s\"\ngit push origin master\ngit push --tags\nnpm publish\n```\n\n## Automated screenshot taking\n\nTo take screenshots of web pages, you need to display the pages inside a browser. To do reliably and at large scales, you need the navigation to the site and dimensioning of the viewport to be automated. You need an automated (headless?) browser.\n\nThe best automated browsers are:\n\n- [PhantomJS](http://phantomjs.org/) (WebKit, engine of Safari, headless).\n- [SlimerJS](https://slimerjs.org/) (Gecko, engine of Firefox, not truly headless yet).\n- [Electron](http://electron.atom.io/) (Chromium/Blink, engine of Chrome, not truly headless?).\n\nI have had issues with the screenshots taken by Phantom (via [pageres](https://github.com/sindresorhus/pageres/), via [screenshot-stream](https://github.com/kevva/screenshot-stream)), and SlimerJS ([homemade](https://github.com/springload/madewithwagtail/blob/c4a6e16b0196e794cd807709b5a00da807181039/scripts/slimerjs-screenshot.js)), so it is now time to try Electron.\n\n- Nightmare screenshots implementation https://github.com/segmentio/nightmare/blob/master/lib/runner.js#L416\n- Electron screenshot https://github.com/electron/electron/blob/master/docs/api/browser-window.md#wincapturepagerect-callback, https://gist.github.com/twolfson/0d374d9d7f26eefe7d38\n- https://github.com/FWeinb/electron-screenshot-app\n- https://github.com/FWeinb/electron-screenshot-service\n- https://github.com/JamesKyburz/electron-screenshot\n- https://github.com/victorferraz/break-shot\n\nCode originally taken from https://github.com/thibaudcolas/is-js-error, and https://github.com/sindresorhus/pageres/\n\nHere are common pitfalls of automated screenshot taking:\n\n- Web fonts support and loading\n- HTTPS or mixed-source support\n- Images loading\n- Animations that execute on page load (carousels)\n- Modals, overlays, and interstitials\n- EU-law cookie messages\n\nTo research: https://github.com/NullCrayfish/CookiesOK\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringload%2Fscreenshotron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspringload%2Fscreenshotron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspringload%2Fscreenshotron/lists"}