https://github.com/libbum/odyssey
Next generation gallery. Exceptional images deserve an exceptional presentation.
https://github.com/libbum/odyssey
elm gallery photo-browser photo-gallery rust travel-blog
Last synced: about 2 months ago
JSON representation
Next generation gallery. Exceptional images deserve an exceptional presentation.
- Host: GitHub
- URL: https://github.com/libbum/odyssey
- Owner: Libbum
- License: bsd-3-clause
- Created: 2018-10-18T21:24:41.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-21T22:11:52.000Z (almost 2 years ago)
- Last Synced: 2025-04-30T18:08:00.716Z (about 2 months ago)
- Topics: elm, gallery, photo-browser, photo-gallery, rust, travel-blog
- Language: Elm
- Homepage: https://odyssey.neophilus.net
- Size: 1.31 MB
- Stars: 34
- Watchers: 3
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Odyssey
A photoblog of my adventures. [https://odyssey.neophilus.net](https://odyssey.neophilus.net)
## Usage
If you wish to use something similar, there are a few conventions you need to abide by.
### Directory structure
Odyssey assumes all images reside in `dist/gallery` under a directory structure that follows `///`, for example `2015/04/Norway/Oslo`.
Places and countries with spaces in their names should be rendered as `Ho_Chi_Minh_City`.
Image files can be named however you wish.
### odyssey.yaml
Once your files are stored correctly in the gallery structure there is one important file to maintain.
`manifester/odyssey.yaml` takes care of two lists: `places` and `trips`.
---
Places requires a list of all countries in the gallery with sub-lists of locations in the gallery.
As Odyssey is targeting English, local names can be stored here and will be incorporated into the gallery.
The local name for a country should be a sub-list element:
```yaml
Norway:
Local: Norge
```
Locations can be the value corresponding to the sub-list's key: `Gothenburg: Göteborg`.
So a complete example could be:
```yaml
places:
Sweden:
Local: Sverige
Are: Åre
Gothenburg: Göteborg
Stockholm:
```
---
The Trips list is a little more involved, but needs to be so that the paths that are traced on the globe look like you'd anticipate.
Here's an example from my trip list to study:
```yaml
trips:
- name: S16
description: Summer 2016
cities:
- Gothenburg
- Frankfurt
- Vienna
- Yerevan
- Vienna
- Frankfurt
- Gothenburg
- Tallinn
- Helsinki
- Gothenburg
- Stockholm
- Gothenburg
- Copenhagen
- Crete
- Athens
- Frankfurt
- Freiburg
- Frankfurt
- Gothenburg
dates:
- 2016/05
- 2016/06
- 2016/07
- 2016/09
```
- `name` is an identifier that is used internally to identify each trip. Choose a short but unique ID.
- `description` is the one that shows up in the filter list in the menu, as well as the URL.
- `cities` is a list of locations visited, in order on your trip. You can easily see that I was living in Gothenburg in 2016, since I start and end there, as well as stopped by multiple times during `Summer 2016`. The world map traces this list and puts a line between each pair in the list. It makes sense that my day trip to `Stockholm` is sandwiched between two `Gothenburg`s—otherwise the world map would show me jumping from `Stockholm` to `Copenhagen`, which didn't happen.
- `dates` is a crude but effective method of filtering trips. Simply list the months your trip was on here, and the gallery will grab all images from the list of cities within the time-frame of the months listed here.
### .desc files
The manifester generates empty `.desc` files for each image if one doesn't exist.
If you wish to add a short description to a photo, write it in this file and the manifester will add it next pass.
This file is not escaped, so please use `\"` if you need quotations in your description.
### attribution.yaml
If you wish to assign a license to the images in your gallery, use the `manifester/attribution.yaml` file.
Initially, you'll want to rename the `manifester/attribution.example.yaml` file to `manifester/attribution.yaml`.
I've done this so that users just trying this repo out, don't apply my personal attribution to their photos accidentally.
By default, `Marked` will be set to *false*, thus skipping this step in the manifest building process.
Switching this value to *true* will turn on a routine the will inject xmp metadata into each of your images.
It will not alter any other exif data, but will overwrite any licensing data that may exist on your image already.
This is not ideal and will be [fixed in the future](https://github.com/Libbum/Odyssey/issues/51).
In general though, this allows you to play around with your attribution file and each manifest build will change the agreement metadata in your images.
#### Choosing a license
I'd recommend a Creative Commons license.
Many of which allow copying freely, but also have options for a non-commercial use clause.
This is what I choose: [Creative Commons Attribution-NonCommercial-Share Alike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/)
Creative Commons have a great [selector](https://creativecommons.org/choose/) on their website with ample information about each choice.
At the moment, the routines herein only support the CC scheme, so if you'd like to include something other than their licenses, please [file an issue](https://github.com/Libbum/Odyssey/issues).
### Updating a gallery
Once your files are organised, you can build your manifest by calling `make manifest`. This will generate all needed code for the updated `world.json` and `Manifest.elm` files.
`make build` will generate all the javascript for the app, so you can preview the gallery before deployment: `make serve` will do this for you.
`deploy` is a one-command update and upload trigger, so if you've just added images and nothing else, this is the only tool you want.
## Development
Assumes you're using a modern linux distro with [Elm 0.19](https://elm-lang.org/) and [Rust](https://www.rust-lang.org/) installed. As well as the inclusion of [elm-live](https://github.com/wking-io/elm-live), [uglifyjs](http://lisperator.net/uglifyjs/) and [crass](https://github.com/mattbasta/crass) in your toolchain.
`make debug` gives you the Elm time-travelling debugger when live-previewing your changes.
## License
Images in this gallery are licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
Contact me directly if you wish to use an image for commercial purposes.
---
Code for this gallery is released under the BSD 3-Clause "New" or "Revised" License, in line with most Elm libraries used within.
[](https://app.fossa.io/projects/git%2Bgithub.com%2FLibbum%2FOdyssey?ref=badge_large)