memories/README.md

63 lines
3.6 KiB
Markdown
Raw Normal View History

2022-10-16 04:45:29 +00:00
![Screenshot](appinfo/screenshot.jpg)
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
![GitHub](https://img.shields.io/github/license/pulsejet/memories)
[![e2e](https://github.com/pulsejet/memories/actions/workflows/e2e.yaml/badge.svg)](https://github.com/pulsejet/memories/actions/workflows/e2e.yaml)
[![Demo](https://img.shields.io/badge/demo-online-blue)](https://memories-demo.radialapps.com/apps/memories/)
[![Gitter](https://img.shields.io/gitter/room/pulsejet/memories)](https://gitter.im/pulsejet/memories)
[![GitHub issues](https://img.shields.io/github/issues/pulsejet/memories)](https://github.com/pulsejet/memories/issues)
2022-11-14 08:05:29 +00:00
[![GitHub Sponsor](https://img.shields.io/github/sponsors/pulsejet?logo=GitHub)](https://github.com/sponsors/pulsejet)
2022-10-20 00:35:03 +00:00
Memories is a _batteries-included_ photo management solution for Nextcloud with advanced features
## 🎁 Features
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.
- **🤖 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.
2023-03-08 16:44:47 +00:00
- **✏️ Edit Metadata**: Edit dates and other metadata 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.
2023-02-09 19:16:03 +00:00
- **🗺️ Map**: View your photos on a map, tagged with accurate reverse geocoding.
- **⚡️ Performance**: Memories is very fast.
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-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).
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
2023-03-08 04:49:39 +00:00
1. ☁ Clone this into your `custom_apps` folder of your Nextcloud.
2022-08-16 01:28:40 +00:00
1. 👩‍💻 In a terminal, run the command `make dev-setup` to install the dependencies.
2023-02-24 17:51:21 +00:00
1. 🏗 To build/watch the UI, run `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
## 🤝 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)
2023-03-08 18:53:03 +00:00
[<img src="https://github.com/ChickenTarm.png" width="42" />](https://github.com/ChickenTarm)
2022-11-14 08:03:46 +00:00
## 📝 Changelog
2022-11-14 17:54:19 +00:00
For the full changelog, see [CHANGELOG.md](CHANGELOG.md).
## 🙏 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).