moul

The minimalist photo collection generator.

Usage no npm install needed!

<script type="module">
  import moul from 'https://cdn.skypack.dev/moul';
</script>

README

moul •

The minimalist photo collection generator.

Demo: https://demo.moul.app

Features

  • Simplicity simple and easy to use
  • Smart deterministic image layout
  • JAMStack Future proof JAMStack
  • The One One Binary to rule them all

Installation

Download a single binary, add to $PATH and you’re done

Don't know what todo?

macOS 

curl -s https://moul.app/install.sh | sh

Linux

coming soon

Windows

coming soon

Usage

# Create new photo collection
$ moul new my-collection

# Place photos into its desire folders

# Add your information in config.json

# Generate your photo collection
$ cd my-collection && moul dev

# Build
$ moul build

It depends on how many photos you added to photos/collection, the command moul dev might take a while. It's a good time to grab coffee.

Recommended size

  • photos/cover: Any landscape aspect ratio will work fine (recommended: 2560px wide)
  • photos/profile: Square - 1:1 aspect ratio (recommended: 1024px wide)
  • photos/collection: Any aspect ratio (recommended: 2048px wide)

Configuration

{
  "site": {
    "url": "https://demo.moul.app",
    "name": "Moul",
    "bio": "The minimalist photo collection generator"
  },
  "social": {
    "twitter": "mouldotco",
    "youtube": "",
    "facebook": "",
    "instagram": ""
  }
}

The link for twitter will be come https://twitter.com/mouldotco

Deployment

You can pretty much deploy the dist folder to any static site hosting. That includes

and more.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments