photoprism/README.md
2018-12-14 04:43:50 +01:00

77 lines
4.6 KiB
Markdown

PhotoPrism: Browse your life in pictures
========================================
[![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]
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.
![](https://photoprism.org/images/fulls/02.jpg)
More screenshots: https://photoprism.org/#screenshots
## What to expect
* 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.
## For the early birds
You are welcome to get an impression and provide early feedback.
**[Step-by-step instructions](https://docs.photoprism.org/en/latest/setup/)** can be found
in our [User Guide](https://docs.photoprism.org/en/latest/).
Developers can skip this and move on to the [Developer Guide](https://github.com/photoprism/photoprism/wiki).
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.
Note that we just [started working](https://github.com/photoprism/photoprism/wiki/Project-Status)
on the UI and features are neither complete nor stable.
Leave your email to get a [release notification](https://goo.gl/forms/KBPVGl9PCsOKrAv33).
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).
## Why this has to be free software
The development of every commercial product is focused on monetization.
We've [built similar apps more than once](https://github.com/photoprism/photoprism/wiki/Mediencenter) 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.
Go, the programming language we're using, is a great example. It is heavily influenced by the ideas of Niklaus Wirth.
> 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.
> — NIKLAUS WIRTH, CACM, FEB. 1985
## How to contribute
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.
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)
to receive regular project updates and discuss development related topics. Don't be afraid to ask stupid questions.
## Donations
We don't want to ask individuals for a donation at the moment. Please leave a star if you like this project, it provides enough motivation to keep going.
Thank you very much! <3
## Sponsorship
Developing open-source software is a community effort. Solid funding enables us to quickly implement features and integrate with services you care about. Grants and donations will be used for [organizing meetups](https://github.com/photoprism/photoprism/wiki/Meetups), [running our servers](https://github.com/photoprism/photoprism/wiki/Infrastructure), visiting conferences, buying test devices, offering perks for contributions, and covering our cost of living.
See [SPONSORS.md](SPONSORS.md) for details.
[license]: https://github.com/photoprism/photoprism/blob/develop/LICENSE
[goreport]: https://goreportcard.com/report/github.com/photoprism/photoprism
[coverage]: https://codecov.io/gh/photoprism/photoprism
[ci]: https://travis-ci.org/photoprism/photoprism
[docs]: https://docs.photoprism.org/en/latest/