This project is no longer being maintained by me. Please go to https://github.com/waschinski/photo-stream/ a version maintained by someone who actually knows what they're doing :)
- How to Install
- How to use
- Known issues
- Lazy loading
- Only load larger resolutions when needed (to save on bandwidth)
- Photo tints
- Keyboard shortcuts
- Unique URL's for photos
- RSS feed (Which you can plug into IFTTT and set up auto-posting to most social networks, like I've done here. Make sure you select "Post a tweet with image" when setting it up to embed the photo.)
- Drag, drop, commit workflow (learn more about how to add photos to your stream)
- Optimized light and dark themes (auto-enabled depending on your OS preferences)
- Optional: Links to your social networks
We like to take photos and share them. Problem is it's hard to really own your photos and how they're represented across social media these days, so we set out to make a place for them. You host it yourself, wherever you want (Netlify, Github Pages...), you're in control.
How to install
The easy way
- Fork this repo
- Clear the
- Add your own photos
- Deploy your forked copy to Netlify (free by default, you can add your own domain and analytics for a reasonable price)
- In your build & deploy settings, set "Build command" to
jekyll buildand "Publish directory" to
- Enjoy your very own photo stream!
The slightly-less-easy-but-still-totally-doable way
Check to see if you have Ruby installed (
ruby -v). If you don't, you can follow the installation instructions provided here.
Next you'll have to install Jekyll (a simple
gem install bundler jekyll should suffice).
You'll also need some additional dependencies:
# Make sure xcode CLT is installed first: xcode-select --install # This takes a while. Plug your laptop in and go grab a coffee, a book, or just # like, take a sec away from the computer and breathe for a bit. brew install glib vips
How to use
Put your photos (not resized) in the
photos/originals directory. Optionally you can give them a name, which will appear as the title of the photo page and in the RSS feed.
This command will serve the static page on your local machine. http://localhost:4000
bundle exec jekyll serve
You can also statically build your site to be uploaded to a regular webhost.
bundle exec jekyll build
Now upload the contents of the _site/ directory to your webserver.
Automating the build & upload with rsync
Copy the bash script 'build-n-rsync.sh' from the _script directory to the root of your photo-stream folder. Fill in the required credentials & run the script. It will build & upload your site.
First thing you want to do is edit a couple of things in
title: The title of your photo stream
name: Your name
website: Your website (could be the address of this photo stream)
description: Description of your photo stream
baseurl: Should be
⚠️Do not change unless you know what you're doing
url: Where will this photo stream live (example:
twitter_username: Your Twitter username
github_username: Your Github username
instagram_username: Your Instagram username
Don't include the
@-part of your social handles. By default links to your Github and Instagram profiles are hidden. You can uncomment these by going into
/index.html. There, you can also add links to wherever you want. Just add more
class="link" to the
<ul class="links"> list.
Before publishing your website, Jekyll will resize your photos into 3 different buckets:
/photos/large: These are only shown when a user navigates to a photo page. By default these are resized to a maximum of 2048 wide and 2048 tall. If you wish, you can change these by changing the values in
/_config.yml(by default they look something like this:
resize_to_limit: [2048, 2048]).
/photos/thumbnail: These are used in the grid. Photo Stream will load all thumbnails above the fold, then more as you scroll down; all to save bandwidth. Standard size for these is 640 by 640 (max), but you can also change this if needed.
/photos/tint: What you see while the page loads its first batch of thumbnails, also used as the background for photo pages.
⚠️Do not make changes to the tint versions in your config file.
- You might see a
VIPS-WARNINGmessage while running
jekyll serve. This is a bug in libvips that's being tracked, but it's harmless.