https://github.com/anttiromppanen/viewsnap
Creates a collection of snapshots of a webpage for various viewport dimensions.
https://github.com/anttiromppanen/viewsnap
css frontend frontend-web html javascript playwright responsive responsive-design responsive-web-design web web-development
Last synced: about 2 months ago
JSON representation
Creates a collection of snapshots of a webpage for various viewport dimensions.
- Host: GitHub
- URL: https://github.com/anttiromppanen/viewsnap
- Owner: anttiromppanen
- License: mit
- Created: 2024-10-20T09:08:24.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T05:51:02.000Z (6 months ago)
- Last Synced: 2024-10-24T09:11:44.574Z (6 months ago)
- Topics: css, frontend, frontend-web, html, javascript, playwright, responsive, responsive-design, responsive-web-design, web, web-development
- Language: TypeScript
- Homepage:
- Size: 1.04 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Viewsnap
A Node.js CLI tool that captures responsive snapshots of a website, generating images for multiple viewport sizes. This allows developers to quickly test and visualize how their web pages appear across different devices and browsers, from mobile to desktop, streamlining the process of ensuring a responsive design.
> **_NOTE:_** Animations on a website may produce various different results on the images.
## Usage
**Option 1:** Use directly with npx
```javascript
npx viewsnap generate
```
**Option 2:**
Install viewsnap package globally
```javascript
npm install -g viewsnap
```
```javascript
viewsnap generate
```
**Option 3:** install to project scope, and add the command to PATH variable
```javascript
npm install viewsnap --save-dev
```
Add the viewsnap command to PATH variable:
```javascript
export PATH=$PATH:$(npm bin -g)
```
```javascript
viewsnap generate
```
*Snapshots* and an overview page *snapshots.html* are stored in .viewsnap directory.
## Commands
### `generate` Command
The generate command takes snapshots of a website URL given as a parameter. Snapshots are taken with multiple viewport sizes covering the most common device viewports from desktop, tablet, and mobile devices. Viewport snapshots are taken with three different headless browsers (Chrome, Firefox, WebKit).
**Syntax:**
```javascript
viewsnap generate [options]
```
**URL**
* URL for a website, can be local or web-hosted
**Options**
* -f, --full-height, option sets the viewport height for full height of the page.
**Example output:**
```
npm viewsnap generate http://localhost:5137
```
*snapshots.html:*
## Contributing
All contributions are welcome, please read [how to contribute](CONTRIBUTING.md) first.