2018-08-23 12:17:04 +00:00
|
|
|
![PhotoPrism](docs/img/logo.png)
|
2018-02-27 18:46:50 +00:00
|
|
|
|
2018-08-23 12:44:21 +00:00
|
|
|
A free tool for importing, indexing and searching large amounts of JPEG and RAW files
|
|
|
|
=====================================================================================
|
|
|
|
|
2018-02-27 18:46:50 +00:00
|
|
|
[![Build Status](https://travis-ci.org/photoprism/photoprism.png?branch=master)][ci]
|
|
|
|
[![Code Quality](https://goreportcard.com/badge/github.com/photoprism/photoprism)][code quality]
|
|
|
|
[![GitHub issues](https://img.shields.io/github/issues/photoprism/photoprism.svg)][issues]
|
|
|
|
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)][license]
|
|
|
|
|
|
|
|
[ci]: https://travis-ci.org/photoprism/photoprism
|
2018-02-28 14:56:32 +00:00
|
|
|
[code quality]: https://goreportcard.com/report/github.com/photoprism/photoprism
|
2018-02-27 18:46:50 +00:00
|
|
|
[issues]: https://github.com/photoprism/photoprism/issues
|
|
|
|
[license]: https://github.com/photoprism/photoprism/blob/master/LICENSE
|
|
|
|
|
2018-08-23 12:44:21 +00:00
|
|
|
Originals, thumbnails and metadata are stored in the file system for easy
|
2018-02-27 19:17:13 +00:00
|
|
|
backup and reliable long-term accessibility.
|
2018-02-27 18:46:50 +00:00
|
|
|
|
2018-08-23 12:44:21 +00:00
|
|
|
This software is still alpha and under active development. You're welcome to join our team.
|
|
|
|
|
|
|
|
Our goal is to provide the following features (tested as a proof-of-concept):
|
|
|
|
|
|
|
|
- High-performance command line tool
|
|
|
|
- Web frontend
|
|
|
|
- No proprietary or binary data formats
|
|
|
|
- Duplicate detection
|
|
|
|
- Automated tagging using Google TensorFlow
|
2018-08-23 12:45:42 +00:00
|
|
|
- Reverse geocoding based on latitude and longitude
|
2018-08-23 12:44:21 +00:00
|
|
|
- Image search with powerful filters
|
|
|
|
- Easy backup and export
|
|
|
|
|
2018-08-15 07:59:51 +00:00
|
|
|
![](docs/img/search.png)
|
|
|
|
|
2018-03-26 04:32:48 +00:00
|
|
|
Setup
|
|
|
|
-----
|
|
|
|
Before you start, make sure you got Git and Docker installed on your system.
|
|
|
|
Instead of using Docker, you can also setup your own runtime environment
|
|
|
|
based on the existing Docker configuration.
|
2018-02-27 18:46:50 +00:00
|
|
|
|
2018-03-26 04:32:48 +00:00
|
|
|
**Step 1:** Run [Git](https://getcomposer.org/) to clone this project:
|
2018-02-27 19:17:13 +00:00
|
|
|
|
2018-03-26 04:32:48 +00:00
|
|
|
```
|
|
|
|
git clone git@github.com:photoprism/photoprism.git
|
|
|
|
```
|
2018-02-28 09:04:24 +00:00
|
|
|
|
2018-03-26 04:32:48 +00:00
|
|
|
**Step 2:** Start [Docker](https://www.docker.com/) containers:
|
2018-02-27 19:17:13 +00:00
|
|
|
|
2018-03-26 04:32:48 +00:00
|
|
|
```
|
|
|
|
cd photoprism
|
|
|
|
docker-compose up
|
|
|
|
```
|
2018-02-27 19:17:13 +00:00
|
|
|
|
2018-03-26 04:32:48 +00:00
|
|
|
*Note: This docker-compose configuration is for testing and development purposes only.*
|
2018-02-27 19:51:19 +00:00
|
|
|
|
2018-03-26 04:32:48 +00:00
|
|
|
**Step 3:** Open a terminal to run commands and unit tests:
|
2018-02-27 19:17:13 +00:00
|
|
|
|
|
|
|
```
|
2018-03-26 04:38:02 +00:00
|
|
|
docker-compose exec photoprism bash
|
2018-09-05 18:26:03 +00:00
|
|
|
go build ./...
|
|
|
|
go test ./...
|
2018-08-15 07:59:51 +00:00
|
|
|
go run cmd/photoprism/photoprism.go migrate-db
|
|
|
|
go run cmd/photoprism/photoprism.go start
|
2018-02-27 19:17:13 +00:00
|
|
|
```
|
|
|
|
|
2018-09-05 18:26:03 +00:00
|
|
|
This project uses modules and requires Go 1.11 or later. See https://github.com/golang/go/wiki/Modules for more information.
|
|
|
|
|
2018-08-23 12:44:21 +00:00
|
|
|
Concept
|
|
|
|
-------
|
2018-03-26 04:32:48 +00:00
|
|
|
|
2018-07-27 15:31:39 +00:00
|
|
|
![](docs/img/concept.jpg)
|