photoprism/README.md

76 lines
4.1 KiB
Markdown
Raw Normal View History

2018-10-05 19:19:46 +02:00
PhotoPrism: Browse your life in pictures
2018-10-05 08:27:45 +02:00
========================================
2018-08-23 14:44:21 +02:00
[![License: GPL](https://img.shields.io/badge/License-GPL-blue.svg)][license]
[![Code Quality](https://goreportcard.com/badge/github.com/photoprism/photoprism)][goreport]
[![Test Coverage](https://codecov.io/gh/photoprism/photoprism/branch/develop/graph/badge.svg)][coverage]
[![Build Status](https://travis-ci.org/photoprism/photoprism.png?branch=develop)][ci]
[![Documentation](https://readthedocs.org/projects/photoprism-docs/badge/?version=latest&style=flat)][docs]
2018-02-27 19:46:50 +01:00
2018-10-13 17:40:57 +02:00
PhotoPrism is a server-based application for browsing, organizing and sharing your personal photo collection.
It makes use of the latest technologies to automatically tag and find pictures without getting in your way.
Say goodbye to solutions that force you to upload your visual memories to the cloud or pay monthly fees.
2018-09-27 15:46:20 +02:00
2018-10-09 04:45:43 +02:00
![](https://photoprism.org/images/fulls/02.jpg)
More screenshots: https://photoprism.org/#screenshots
2018-10-13 17:28:53 +02:00
## What to expect
2018-09-27 15:46:20 +02:00
2018-10-05 16:31:57 +02:00
* Clearly structured Web interface for browsing, organizing and sharing your personal photo collection.
* Import everything without worrying about duplicates or RAW to JPEG conversion.
* Reverse geocoding and automated tagging based on Google TensorFlow.
* No monthly costs. No proprietary formats. No privacy concerns.
2018-09-27 22:40:38 +02:00
2018-10-13 17:28:53 +02:00
## For the early birds
2018-10-13 17:28:53 +02:00
You are welcome to get an impression and provide early feedback.
2018-10-13 19:54:29 +02:00
**[Step-by-step instructions](https://docs.photoprism.org/en/latest/setup/)** can be found
2018-10-13 19:24:05 +02:00
in our [User Guide](https://docs.photoprism.org/en/latest/).
2018-10-09 22:51:58 +02:00
Developers can skip this and move on to the [Developer Guide](https://github.com/photoprism/photoprism/wiki).
2018-10-13 19:54:29 +02:00
All you need is a Web browser and [Docker](https://store.docker.com/search?type=edition&offering=community)
to run the server. It is available for Mac, Linux and Windows.
2018-11-19 06:12:52 +01:00
Note that we just [started working](https://github.com/photoprism/photoprism/wiki/Project-Status)
on the UI and features are neither complete nor stable.
2018-11-22 20:13:16 +01:00
Leave your email to get a [release notification](https://goo.gl/forms/KBPVGl9PCsOKrAv33).
2018-11-22 21:20:55 +01:00
If you have a question, don't hesitate to ask in our [help forum](https://groups.google.com/a/photoprism.org/forum/#!forum/help)
or [contact us via email](mailto:hello@photoprism.org).
2018-10-13 19:54:29 +02:00
2018-10-13 17:28:53 +02:00
## Why this has to be free software
2018-10-13 17:28:53 +02:00
The development of every commercial product is focused on monetization.
We've built similar apps more than once and every single time the constraints of working
in a profit-oriented corporate environment were an impediment.
We are sure we can do better with only a fraction of the budget. Simplicity can be very powerful.
2018-10-13 18:22:21 +02:00
Go, the programming language we're using, is a great example. It is heavily influenced by the ideas of Niklaus Wirth.
2018-10-13 17:28:53 +02:00
> Simple, elegant solutions are more effective, but they are harder to find than complex ones, and they require more time, which we too often believe to be unaffordable.
2018-10-13 17:38:02 +02:00
> — NIKLAUS WIRTH, CACM, FEB. 1985
2018-10-13 17:28:53 +02:00
## How to contribute
2018-10-05 16:31:57 +02:00
2018-10-13 17:38:02 +02:00
We welcome contributions of any kind. If you have a bug or an idea, read our
[guide](https://docs.photoprism.org/en/latest/contribute/) before opening an issue.
2018-11-22 20:02:24 +01:00
Issues labeled [help wanted](https://github.com/photoprism/photoprism/labels/help%20wanted) /
[easy](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy) can be
good (first) contributions. Please join our
[developers mailing list](https://groups.google.com/a/photoprism.org/forum/#!forum/developers)
2018-11-23 11:44:23 +01:00
to receive regular project updates and discuss development related topics. Don't be afraid to ask stupid questions.
2018-10-05 16:31:57 +02:00
2018-10-13 17:28:53 +02:00
## Donations
2018-10-05 19:21:31 +02:00
2018-10-08 22:36:19 +02:00
Please leave a star if you like this project, it provides enough motivation to keep going.
Thank you very much! <3
2018-10-05 19:21:31 +02:00
2018-10-13 17:28:53 +02:00
## Sponsorship
2018-10-10 03:36:02 +02:00
2018-12-11 20:58:13 +01:00
Millions are wasted in commercial software projects every day. This is your chance to spend a tiny fraction of your budget for something truly useful. See [SPONSORS.md](SPONSORS.md) for details.
2018-10-10 03:36:02 +02:00
2018-11-19 04:24:43 +01:00
[license]: https://github.com/photoprism/photoprism/blob/develop/LICENSE
[goreport]: https://goreportcard.com/report/github.com/photoprism/photoprism
2018-11-19 04:24:43 +01:00
[coverage]: https://codecov.io/gh/photoprism/photoprism
[ci]: https://travis-ci.org/photoprism/photoprism
[docs]: https://docs.photoprism.org/en/latest/