bebraw / stalbum Goto Github PK

Static album generator (MIT)

Home Page: http://bebraw.github.io/stalbum-starter/

License: MIT License

JavaScript 99.61% Shell 0.39%

stalbum's Introduction

stalbum

stalbum is a static image gallery generator. It simply takes in a directory of images and a couple of templates based on which it constructs a gallery. The gallery consists of albums (maps to directory) that are displayed using thumbnails.

See demo/ to get started. Alternatively you can just clone stalbum-starter and build your albums on top of that.

Dependencies

Node.js (0.10.x is guaranteed to work, earlier might work as well)
npm install the rest
ImageMagick or GraphicsMagick (for thumbnails)

License

stalbum is available under MIT. See LICENSE for more details.

stalbum's People

Contributors

Stargazers

Watchers

stalbum's Issues

Use GraphicsMagick instead of ImageMagick

There are bindings available.

Implement plugin architecture?

It might be neat if it was possible to extend stalbum using external plugins. Just need to specify this better. What sort of plugins would be useful? Can some of the existing functionality be converted to plugins?

Document templates

Document the idea behind templates and the available variables.

More storage options

S3 can become very expensive for big high traffic websites.
It would be awesome if the user could mount his own linux server storage via NFS.

Move custom CSS and JS declarations to a head matter

Define something like the following at the beginning of templates:

js: ['foo', 'bar']
css: ['baz']

---
content goes here

The content at head matter should be then injected to the master template (match by name). There can be a convention that generates proper script templates. Later on that can be generalized to something prettier.

Investigate ENOMEM

Trace below:

stalbum 0.5.4


child_process.js:927
    throw errnoException(process._errno, 'spawn');
          ^
Error: spawn ENOMEM
    at errnoException (child_process.js:980:11)
    at ChildProcess.spawn (child_process.js:927:11)
    at Object.exports.spawn (child_process.js:715:9)
    at exec2 (/usr/lib/node_modules/stalbum/node_modules/imagemagick/imagemagick.js:24:25)
    at Object.exports.identify (/usr/lib/node_modules/stalbum/node_modules/imagemagick/imagemagick.js:149:14)
    at /usr/lib/node_modules/stalbum/lib/photos.js:29:12
    at /usr/lib/node_modules/stalbum/node_modules/async/lib/async.js:224:13
    at /usr/lib/node_modules/stalbum/node_modules/async/lib/async.js:108:13
    at Array.forEach (native)
    at _each (/usr/lib/node_modules/stalbum/node_modules/async/lib/async.js:32:24)

Set up benchmarking

This way it is easier to keep track on the performance after changes.

Replace mkdir with mkdirp

Looks like there's a ready made module for this. Better use that.

In case images option is provided but the directory is not found, give a nice error

Allow albums to be recursive

This means albums should be able to contains albums etc.

Watch option

It would be handy if it was possible to invoke stalbum in watch mode. It would just watch the input files and templates and then run the tool on change.

If implemented well, it should be able to support partial updates.

Escape special characters in directory and image names

Support incremental updates

In case new images are added to the system it can be useful if stalbum generates html and thumbnail only for those rather than for each.

Attach width/height to thumbnails properly

Set up a master template

This would be shared by actual templates and contain things like basic HTML declarations (header etc.) and a content slot where the template that inherits is injected.

Provide starter templates

There should be a couple of good looking starter templates. Or alternative styles in case it is possible to come up with a sensible starting HTML.

Implement index

It should contain links to albums.

Provide progress information

Esp. on slower systems it is nice to see what is going on.

Link from album to images

Figure out which metadata is required and attach it.

Allow photo dimensions to be changed

Now it uses original data. It would be good to be able to resize that into something else as you might not want to share the original data always.

Allow metadata to be provided

It should be possible to load metadata related to photos and provide that to the template. If there is a JSON or YAML file that has been named the same way as the photo itself (ie. foo.jpg and foo.json), it should load the data and then pass that to the context.