dphoto

README

DPhoto

Backup photo to your private AWS Cloud, and share them with family and friends. Core features:

Feature	Version	Description
Backup medias	v0.1	Backup photos and videos from USB Sticks, Flash drives, and Camera (USB) when they're plugged
Organise by album	v0.1	Photos and videos are organised by album based on their creation date. Each album is a directory in S3.
Migration script	v0.1	Medias already uploaded in S3 are re-ordered by albums and de-duplicated (with interactive command line interface)
Web viewer	v0.5	See photos by albums, tag them, search by tag or dates
Faster UI	v1.0	Pre-generate miniatures, supports browser caching (miniature + medium quality) and backend cache medium-quality images.
Album sharing	v1.3	Albums can be shared to other users
Upgraded sharing	-	Pre-selected emails and globals views, merge owned and shared-with-me albums
Upgraded album views	-	Albums are listed by most recent medias, medias can be listed by dates (without being grouped by albums
Upgraded backup	-	Backup directly to the cloud (WebDAV), cleaning/filtering possible after backup
Photo Frame	-	Generate a random pick of media for a photo frame
Album contribution	-	Several users can contribute to the same album (families, friend group)
API Driven	-	Provide enhanced API to tip the business on the backend side: CLI authenticated by Google Token (vs AWS Credentials)
Android App	-	Minimalist app to synchronise local medias to DPhoto.
Tagging	-	Adding tags to medias to find them later, share them, or print them
Google Photo	-	Support Google Photo to push images and video, or import from Google Photo.

Getting Started

Install 'dphoto' command line interface and configure it using the following:

go install github.com/thomasduchatelle/dphoto/cmd/dphoto@latest
dphoto configure

Then use command backup to upload media in a directory, or scan to interactively organise the albums.

dphoto scan /x/y/z
dphoto backup /x/y/z

Evaluate locally

To run the command line interface locally - using localstack:

# start and configure localstack
make dcup

# move to a directory with a default confi with localstack
cd cmd/dphoto

# backup some pictures
go run . backup <a directory of photo>

# interactively add/remove albums
go run . album -i

# verify album changes has been applied
AWS_ACCESS_KEY_ID=localstack AWS_SECRET_ACCESS_KEY=localstack aws --endpoint http://localhost:4566 --region us-east-1 s3 --recursive s3://dphoto-local

Contribute

Components:

• deployments/infra-data: terraform project to create required infrastructure on AWS for the CLI to work. Project won't be re-usable in a different context without overriding backend and some other defaults.
• pkg: core domain model and business logic from Hexagonal Architecture. This domain is used from both CLI and app's APIs
• DPhoto CLI: installed on the end-user computer, backup photos and videos using command line interface
• APP: deployed on top of infra-data, contains the APP (API deployed on AWS lambdas, and WEB)

Note: the repository follow https://github.com/golang-standards/project-layout structure convention.

Install development environment

Required tools:

• Infra:
  • terraform: brew install tfenv, Makefile
  • Serverless Framework: npm install -g serverless
  • AWS CLI: brew install awscli
• Languages & build tools:
  • make
  • GoLang: brew install golang
  • Yarn: brew install yarn
• Docker and Docker Compose
  • brew install docker docker-compose

Setup the environment:

make setup all

# Run tests & build (all sub-projects)
make

Commit messages & Github Actions

Commit messages are following the convention:

<domain>[/<area>] [+tags] - <message>

With:

• domains: catalog, archive, backup
• area: web, cli, proj, api, ...
• supported tags are:
  • +update-snapshots: snapshots used to test visual regression will be updated
  • +patch, +minor, +major: control the version of the software
  • +pr: creates a Pull Request if the pipeline is successful

Releasing process

Bootstrap an environment with built-in command (one-of pre-requisite):

go run ./tools/infra-bootstrap -domain <domain> -email <email> -env dev -google-client-id <id>

To release a new version:

1. Push a change on a feature branch with +pr or +next in the commit message
2. (optional) Verify "next" is working, check the terraform plan in the PR comment
3. Accept and merge the PR (created automatically on step 1)

Any machine should update to the latest version of the CLI:

go install github.com/thomasduchatelle/dphoto/cmd/dphoto@latest

AWS Support

DPhoto only supports AWS to be deployed as a serverless application using AWS Gateway, Lambdas, DynamoDB, and S3.

DynamoDB is a single table documented in README.md.

TODOs

TODO.md