memories/README.md

# Memories

**📷 Yet another photo management app for Nextcloud**

![Screenshot](appinfo/screencap.gif)

## How is this different?

* **📸 Photo and Video Timeline**: Sorts photos by date taken, parsed from Exif data.
* **🤔 Quick Recap**: Jump to anywhere in the timeline instantly.
* **🖼️ Albums**: Browse your and shared folders with a similar, efficient timeline.
* **🎦 Slideshow**: View photos from your timeline and albums easily.
* **📱 Mobile Support**: Relive your memories on devices of any shape and size through the web app.

## 🚀 Installation

1. ☁ Clone this into your `apps` folder of your Nextcloud.
1. ⚒️ Install `exiftool` (`sudo apt install exiftool`).
1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
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.
1. Consider installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails.

## 🏗 Development setup

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!

## Why a separate app?
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.

## Notes
1. The app has been tested with 100GB worth of ~25k photos.
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`.

## 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).
Rename again to memories Fix the migration directly because I'm the only user right now. If this is a problem for you, drop the oc_polaroid table and the corresponding index on the oc_filecache table. 2022-08-18 18:27:25 +00:00			`# Memories`
Initial Commit 2022-08-13 01:58:37 +00:00
Update readme 2022-08-20 01:07:39 +00:00			`📷 Yet another photo management app for Nextcloud`
Initial Commit 2022-08-13 01:58:37 +00:00
Add screencap 2022-08-18 03:41:26 +00:00			`![Screenshot](appinfo/screencap.gif)`
Add screenshot 2022-08-18 03:36:37 +00:00
Update README 2022-08-16 01:28:40 +00:00			`## How is this different?`
Initial Commit 2022-08-13 01:58:37 +00:00
Update to use exiftool 2022-08-17 21:45:01 +00:00			`* 📸 Photo and Video Timeline: Sorts photos by date taken, parsed from Exif data.`
Update README 2022-08-16 01:28:40 +00:00			`* 🤔 Quick Recap: Jump to anywhere in the timeline instantly.`
Update to use exiftool 2022-08-17 21:45:01 +00:00			`* 🖼️ Albums: Browse your and shared folders with a similar, efficient timeline.`
			`* 🎦 Slideshow: View photos from your timeline and albums easily.`
Add mobile support feature 2022-08-20 01:10:28 +00:00			`* 📱 Mobile Support: Relive your memories on devices of any shape and size through the web app.`
Initial Commit 2022-08-13 01:58:37 +00:00
Update README 2022-08-16 01:28:40 +00:00			`## 🚀 Installation`
Initial Commit 2022-08-13 01:58:37 +00:00
Update README 2022-08-16 01:28:40 +00:00			1. ☁ Clone this into your `apps` folder of your Nextcloud.
Update to use exiftool 2022-08-17 21:45:01 +00:00			1. ⚒️ Install `exiftool` (`sudo apt install exiftool`).
Rename again to memories Fix the migration directly because I'm the only user right now. If this is a problem for you, drop the oc_polaroid table and the corresponding index on the oc_filecache table. 2022-08-18 18:27:25 +00:00			1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
Update readme 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.`
Update README 2022-08-16 01:28:40 +00:00			`1. Consider installing the [preview generator](https://github.com/rullzer/previewgenerator) for pre-generating thumbnails.`
Initial Commit 2022-08-13 01:58:37 +00:00
Update README 2022-08-16 01:28:40 +00:00			`## 🏗 Development setup`
Initial Commit 2022-08-13 01:58:37 +00:00
Update README 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!`
Initial Commit 2022-08-13 01:58:37 +00:00
Update README 2022-08-16 01:28:40 +00:00			`## Why a separate app?`
Fix readme 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.`
Initial Commit 2022-08-13 01:58:37 +00:00
Drop mysql limitation (fix #7, fix #8) 2022-08-20 02:27:27 +00:00			`## Notes`
			`1. The app has been tested with 100GB worth of ~25k photos.`
Add HEIC note 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`.
Add MySQL caveat 2022-08-16 02:13:04 +00:00
Update README 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).`