2022-10-16 04:45:29 +00:00
2022-08-18 03:36:37 +00:00
2022-10-31 19:21:26 +00:00
# Memories: Photo Management for Nextcloud
2022-10-31 19:20:38 +00:00
[](https://github.com/pulsejet/memories/actions/workflows/e2e.yaml)
[](https://memories-demo.radialapps.com/apps/memories/)
[](https://gitter.im/pulsejet/memories)
[](https://github.com/pulsejet/memories/issues)
2022-11-14 08:05:29 +00:00
[](https://github.com/sponsors/pulsejet)
2022-10-20 00:35:03 +00:00
2022-11-09 09:23:12 +00:00
Memories is a _batteries-included_ photo management solution for Nextcloud with advanced features including:
2022-08-13 01:58:37 +00:00
2022-10-28 19:11:08 +00:00
- **📸 Timeline**: Sort photos and videos by date taken, parsed from Exif data.
- **⏪ Rewind**: Jump to any time in the past instantly and relive your memories.
2022-12-08 21:02:29 +00:00
- **🤖 AI Tagging**: Group photos by people and objects, powered by [recognize ](https://github.com/nextcloud/recognize ) and [facerecognition ](https://github.com/matiasdelellis/facerecognition ).
2022-10-28 19:11:08 +00:00
- **🖼️ Albums**: Create albums to group photos and videos together. Then share these albums with others.
2022-10-31 19:09:28 +00:00
- **🫱🏻🫲🏻 External Sharing**: Share photos and videos with people outside of your Nextcloud instance.
2022-10-28 19:11:08 +00:00
- **📱 Mobile Support**: Works on devices of any shape and size through the web app.
2022-10-31 19:09:28 +00:00
- **✏️ Edit Metadata**: Edit dates on photos quickly and easily.
2022-10-28 19:11:08 +00:00
- **📦 Archive**: Store photos you don't want to see in your timeline in a separate folder.
2022-11-09 11:07:05 +00:00
- **📹 Video Transcoding**: Memories transcodes videos and uses HLS for maximal performance.
- **⚡️ Performance**: In general, Memories is extremely fast.
2022-08-13 01:58:37 +00:00
2022-10-31 19:20:38 +00:00
## 🌐 Online Demo
2022-10-28 19:11:08 +00:00
2022-10-31 19:20:38 +00:00
- To get an idea of what memories looks and feels like, check out the [public demo ](https://memories-demo.radialapps.com/apps/memories/ ).
2022-10-31 19:24:37 +00:00
- The demo is read-only and may be slow (free tier VM from [Oracle Cloud ](https://www.oracle.com/cloud/free/ )).
2022-10-31 19:20:38 +00:00
- Photo credits go to [Unsplash ](https://unsplash.com/ ) (for individual credits, refer to each folder).
2022-10-07 21:08:05 +00:00
2022-08-16 01:28:40 +00:00
## 🚀 Installation
2022-08-13 01:58:37 +00:00
2022-10-20 20:45:00 +00:00
1. Install the app from the Nextcloud app store.
2022-10-31 19:23:42 +00:00
1. Perform the recommended [configuration steps ](https://github.com/pulsejet/memories/wiki/Configuration ).
2022-08-18 18:27:25 +00:00
1. Run `php ./occ memories:index` to generate metadata indices for existing photos.
2022-10-31 19:09:28 +00:00
1. Open the 📷 Memories app in Nextcloud and set the directory containing your photos.
2022-08-13 01:58:37 +00:00
2022-10-31 19:09:28 +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.
2022-11-21 10:38:50 +00:00
1. 🏗 To build the Typescript, run `make build-js` . Watch changes with: `make watch-js` . Lint-fix PHP with `make php-lint` .
2022-08-16 01:28:40 +00:00
1. ✅ Enable the app through the app management of your Nextcloud.
2022-10-28 19:11:08 +00:00
1. ⚒️ (Strongly recommended) use VS Code and install Vetur and Prettier.
2022-08-13 01:58:37 +00:00
2022-11-14 07:48:44 +00:00
## Support the project
2022-10-31 19:20:38 +00:00
2022-11-14 07:48:44 +00:00
1. ** 🌟 Star this repository**: This is the easiest way to support Memories and costs nothing.
1. ** 🪲 Report bugs**: Report any bugs you find on the issue tracker.
1. ** 📝 Contribute**: Read and file or comment on an issue and ask for guidance.
1. ** 🪙 Sponsorship**: You can support the project financially at [GitHub Sponsors ](https://github.com/sponsors/pulsejet ).
2022-10-31 19:20:38 +00:00
2022-11-14 08:03:46 +00:00
A shout out to the current and past financial backers of Memories! See the sponsors page for a full list.
[<img src="https://github.com/mpodshivalin.png" width="42" /> ](https://github.com/mpodshivalin )
2023-01-15 21:49:16 +00:00
[<img src="https://github.com/k1l1.png" width="42" /> ](https://github.com/k1l1 )
2022-11-14 08:03:46 +00:00
2022-11-14 17:54:19 +00:00
## Changelog
For the full changelog, see [CHANGELOG.md ](CHANGELOG.md ).
2022-09-13 07:41:06 +00:00
## Special Thanks
2022-10-28 19:11:08 +00:00
Nextcloud team. A lot of this work is based on [Photos ](https://github.com/nextcloud/photos ).
