memories/README.md

3.1 KiB
Raw Blame History

Screenshot

Memories: Photo Management for Nextcloud

GitHub e2e Demo Gitter GitHub issues

Memories is a batteries-included photo management solution for Nextcloud with advanced features including:

  • 📸 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.
  • 🤖 AI Tagging: Group photos by people and objects using AI, powered by recognize.
  • 🖼️ Albums: Create albums to group photos and videos together. Then share these albums with others.
  • 🫱🏻🫲🏻 External Sharing: Share photos and videos with people outside of your Nextcloud instance.
  • 📱 Mobile Support: Works on devices of any shape and size through the web app.
  • ✏️ Edit Metadata: Edit dates on photos quickly and easily.
  • 📦 Archive: Store photos you don't want to see in your timeline in a separate folder.
  • Performance: Memories is extremely fast.

🌐 Online Demo

  • To get an idea of what memories looks and feels like, check out the public demo.
  • The demo is read-only and may be slow (free tier VM from Oracle Cloud).
  • Photo credits go to Unsplash (for individual credits, refer to each folder).

🚀 Installation

  1. Install the app from the Nextcloud app store.
  2. Perform the recommended configuration steps.
  3. Run php ./occ memories:index to generate metadata indices for existing photos.
  4. Open the 📷 Memories app in Nextcloud and set the directory containing your photos.

🏗 Development Setup

  1. ☁ Clone this into your apps folder of your Nextcloud.
  2. 👩‍💻 In a terminal, run the command make dev-setup to install the dependencies.
  3. 🏗 To build the Typescript, run make build-js. Watch changes with: make watch-js.
  4. Enable the app through the app management of your Nextcloud.
  5. ⚒️ (Strongly recommended) use VS Code and install Vetur and Prettier.

How to support development

  1. 🌟 Star this repository: This is the easiest way to support the project and costs nothing.
  2. 🪲 Report bugs: If you find a bug, please report it on the issue tracker.
  3. 📝 Contribute: If you want to contribute, please read file / comment on an issue and ask for guidance.

Special Thanks

Nextcloud team. A lot of this work is based on Photos.