simple-photo-gallery 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +80 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Simple Photo Gallery
|
|
2
|
+
|
|
3
|
+
Create beautiful photo galleries from collections in just 30 seconds. No configuration required to get started—simply run two commands in your photos folder and create a static gallery website you can self-host.
|
|
4
|
+
|
|
5
|
+
This is a free, open-source tool that you can use to generate galleries and self-host them. If you don't want to use the command line or bother with self-hostting, please check out [simple.photo](https://simple.photo) for a hosted solution.
|
|
6
|
+
|
|
7
|
+
## Example Gallries
|
|
8
|
+
|
|
9
|
+
<div align="center">
|
|
10
|
+
<a href="https://simple.photo/demo-australia">
|
|
11
|
+
<img src="docs/images/simple-photo-gallery-demo.jpg" alt="Simple Photo Gallery Demo" width="50%">
|
|
12
|
+
</a>
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
### More examples
|
|
16
|
+
|
|
17
|
+
- [California Road Trip](https://simple.photo/demo-california)
|
|
18
|
+
- [Visiting Australia](https://simple.photo/demo-australia)
|
|
19
|
+
- [Discovering Japan](https://simple.photo/demo-japan)
|
|
20
|
+
|
|
21
|
+
## Features
|
|
22
|
+
|
|
23
|
+
📸 Automatically scan directories with photos and videos
|
|
24
|
+
📝 Show descriptions for photos and videos
|
|
25
|
+
📂 Divide the gallery into sections to tell a story
|
|
26
|
+
🖼️ Create optimized thumbnails for fast loading
|
|
27
|
+
🎥 Play videos directly in the gallery
|
|
28
|
+
📱 Generate galleries that work on all devices
|
|
29
|
+
⚡ Optimized to be fast and lightweight
|
|
30
|
+
🔧 Generate a static HTML gallery that you can self-host
|
|
31
|
+
|
|
32
|
+
## Quick Start
|
|
33
|
+
|
|
34
|
+
The fastest way to create a gallery is to use `npx` in your photos folder:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npx simple-photo-gallery init
|
|
38
|
+
npx simple-photo-gallery build
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
This will:
|
|
42
|
+
|
|
43
|
+
1. Install the [simple-photo-gallery](https://www.npmjs.com/package/simple-photo-gallery) package from NPM (if you don't already have it)
|
|
44
|
+
2. Prompt you for your gallery title, description, and header image
|
|
45
|
+
3. Scan your photos and create a `gallery.json` file
|
|
46
|
+
4. Generate optimized thumbnails
|
|
47
|
+
5. Build a static HTML gallery that you can open in your browser and self-host
|
|
48
|
+
|
|
49
|
+
## Installation Requirements
|
|
50
|
+
|
|
51
|
+
- **Node.js 20+** - [Download here](https://nodejs.org/)
|
|
52
|
+
- **FFmpeg** (for video support) - Install via:
|
|
53
|
+
- macOS: `brew install ffmpeg`
|
|
54
|
+
- Ubuntu/Debian: `sudo apt install ffmpeg`
|
|
55
|
+
- Windows: [Download from ffmpeg.org](https://ffmpeg.org/download.html)
|
|
56
|
+
|
|
57
|
+
## Supported Formats
|
|
58
|
+
|
|
59
|
+
**Images:** JPEG, PNG, WebP, GIF, TIFF
|
|
60
|
+
**Videos:** MP4, MOV, AVI, WebM, MKV
|
|
61
|
+
|
|
62
|
+
## Detailed Documentation
|
|
63
|
+
|
|
64
|
+
For advanced usage, customization, and deployment options, see the comprehensive [documentation](./docs/README.md):
|
|
65
|
+
|
|
66
|
+
- **[Commands Reference](./docs/commands/README.md)** - Detailed guide for all CLI commands
|
|
67
|
+
- [`init`](./docs/commands/init.md) - Initialize new galleries
|
|
68
|
+
- [`build`](./docs/commands/build.md) - Generate static HTML galleries
|
|
69
|
+
- [`thumbnails`](./docs/commands/thumbnails.md) - Generate optimized thumbnails
|
|
70
|
+
- [`clean`](./docs/commands/clean.md) - Remove gallery files
|
|
71
|
+
- **[Gallery Configuration](./docs/configuration.md)** - Manual editing of `gallery.json` and advanced features like sections
|
|
72
|
+
- **[Deployment Guide](./docs/deployment.md)** - Guidelines for hosting your gallery
|
|
73
|
+
|
|
74
|
+
## Python Version
|
|
75
|
+
|
|
76
|
+
The old Python version of Simple Photo Gallery V1 is still available [here](https://github.com/haltakov/simple-photo-gallery), but is now deprecated.
|
|
77
|
+
|
|
78
|
+
## License
|
|
79
|
+
|
|
80
|
+
Simple Photo Gallery is licensed under the MIT License - see [LICENSE](./LICENSE) file for details.
|