memories/README.md

31 lines
1.5 KiB
Markdown
Raw Normal View History

2022-08-16 01:19:43 +00:00
# Polaroid
2022-08-13 01:58:37 +00:00
2022-08-16 01:28:40 +00:00
**📸 Yet another photo management app for Nextcloud**
2022-08-13 01:58: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-16 01:28:40 +00:00
* **📸 Photo and Video Timeline**: Sorts photos by date taken.
* **🤔 Quick Recap**: Jump to anywhere in the timeline instantly.
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-08-16 01:28:40 +00:00
1. ☁ Clone this into your `apps` folder of your Nextcloud.
1. Run `php ./occ polaroid:index` to generate metadata indices for existing photos.
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-16 02:13:04 +00:00
## Limitations
2022-08-16 02:13:21 +00:00
Only works on MySQL/MariaDB for now.
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).