memories/README.md

41 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

# Memories
2022-08-13 01:58:37 +00:00
2022-08-20 01:07:39 +00:00
**📷 Yet another photo management app for Nextcloud**
2022-08-13 01:58:37 +00:00
2022-09-08 01:40:24 +00:00
![Screenshot](appinfo/screencap.webp)
2022-08-18 03:36:37 +00:00
2022-08-16 01:28:40 +00:00
## How is this different?
2022-08-13 01:58:37 +00:00
2022-08-17 21:45:01 +00:00
* **📸 Photo and Video Timeline**: Sorts photos by date taken, parsed from Exif data.
2022-08-16 01:28:40 +00:00
* **🤔 Quick Recap**: Jump to anywhere in the timeline instantly.
2022-09-08 23:57:50 +00:00
* **🖼️ Folders**: Browse your and shared folders with a similar, efficient timeline.
* **🎦 Slideshow**: View photos from your timeline and folders easily.
2022-08-20 01:10:28 +00:00
* **📱 Mobile Support**: Relive your memories on devices of any shape and size through the web app.
2022-09-08 01:40:24 +00:00
* **🗑️ Recycle**: Select and delete multiple photos and videos at once.
2022-08-13 01:58:37 +00:00
2022-08-16 01:28:40 +00:00
## 🚀 Installation
2022-08-13 01:58:37 +00:00
2022-09-09 00:46:16 +00:00
1. Install the app from the Nextcloud app store
2022-08-17 21:45:01 +00:00
1. ⚒️ Install `exiftool` (`sudo apt install exiftool`).
1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
2022-08-20 01:07:39 +00:00
1. Open the 📷 Memories app in Nextcloud and set the directory containing your photos. Photos from this directory will be displayed in the timeline, including any photos in nested subdirectories.
2022-08-16 01:28:40 +00:00
1. Consider installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails.
2022-08-13 01:58:37 +00:00
2022-08-16 01:28:40 +00:00
## 🏗 Development setup
2022-08-13 01:58:37 +00:00
2022-08-16 01:28:40 +00:00
1. ☁ Clone this into your `apps` folder of your Nextcloud.
1. 👩‍💻 In a terminal, run the command `make dev-setup` to install the dependencies.
1. 🏗 Then to build the Javascript whenever you make changes, run `make build-js`. To create a pull request use `make build-js-production`. Watch changes with: `make watch-js`.
1. ✅ Enable the app through the app management of your Nextcloud.
1. 🎉 Partytime!
2022-08-13 01:58:37 +00:00
2022-08-16 01:28:40 +00:00
## Why a separate app?
2022-08-16 01:59:28 +00:00
The approach of this app is fundamentally different from the official Nextcloud Photos app, which is very lightweight and works entirely using webdav. This app instead maintains special metadata in a separate table on the backend, and thus can be considered to have different objectives.
2022-08-13 01:58:37 +00:00
2022-08-20 02:27:27 +00:00
## Notes
1. The app has been tested with 100GB worth of ~25k photos.
2022-08-22 23:04:57 +00:00
1. You may need to configure the Nextcloud preview generator and Imagemagick / ffmpeg to support all types of images and videos (e.g. HEIC). If using the official docker image, add `OC\Preview\HEIC` to `enabledPreviewProviders` in your `config.php`.
2022-08-27 23:05:25 +00:00
1. If local time is not found in the photo (especially for videos), the server timezone is used.
2022-08-16 02:13:04 +00:00
2022-08-16 01:28:40 +00:00
## Special Thanks 🙏🏻
Nextcloud team. At least one half of the code is based on the work of the [Nextcloud Photos](https://github.com/nextcloud/photos).