# gallery-build

> Converts your folder with photos and videos to html gallery

Latest version **1.0.2** (published 2021-12-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install gallery-build
pnpm add gallery-build
yarn add gallery-build
bun add gallery-build
```

Provides the command `gallery-build`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-12-27 |
| First published | 2021-12-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 209.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | thedvlp |
| Maintainers | thedvlp |
| Keywords | photo, video, gallery |

## Links

- npm: https://www.npmjs.com/package/gallery-build
- Repository: https://github.com/thedvlp/gallery-build
- Issues: https://github.com/thedvlp/gallery-build/issues
- npm.io page: https://npm.io/package/gallery-build

## Dependencies (1)

- [minimist](https://npm.io/package/minimist.md) ^1.2.5

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2021-12-27
- 1.0.1 — 2021-12-27
- 1.0.0 — 2021-12-27

## README

# gallery-build
Converts your folder with photos and videos to html gallery.

`gallery-build` will never edit your original files. It is doing only readonly operation on the folder with original files and stores to the path which you define as output. 

`gallery-build` is super lightweight and fast gallery builder node package. It is used as command-line tool to generate web accessible gallery. Later the html file with other files can be copied to any server (home, remote, raspberry) or just used locally by opening `index.html` file.

## Installation

**npm**

```$ npm install -g gallery-build```

## Quick start

To generate gallery run `gallery-build` command by specifying input folder and output folder. 

```$ gallery-build -i /path/to/photos_videos -o /path/to/output```

- `-i` is the path of folder where your photo and videos stored.
- `-o` is the path where `gallery-build` will store generated gallery files (.html file, thumbs, web resized media)

**That's it** Now go to the output path and open `index.html` to view your gallery.

## Requirements

`gallery-build` requires the following dependencies:
- [Node.js](http://nodejs.org/): `brew install node`
- [ImageMagick](https://imagemagick.org/) to process photos: `brew install imagemagick`)
- [FFmpeg](http://www.ffmpeg.org/) to process videos: `brew install ffmpeg`

---
_Source: https://npm.io/package/gallery-build · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._