mirror
/
photoview
mirror of https://github.com/photoview/photoview.git
1
Fork 0
Code

Add content section

This commit is contained in:
viktorstrate 2020-02-23 21:50:15 +01:00
parent b768084b23
commit 09ddbae662
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -9,11 +9,28 @@ Visit https://photos.qpqp.dk/
Username: **demo** Username: **demo**
Password: **demo** Password: **demo**
## Contents
- [Demo site](#demo-site)
- [Aim of the project](#aim-of-the-project)
- [Main features](#main-features)
- [Why yet another self-hosted photo gallery](#why-yet-another-self-hosted-photo-gallery)
- [Getting started - Setup with Docker](#getting-started---setup-with-docker)
- [Setup development environment](#setup-development-environment)
## Aim of the project ## Aim of the project
The aim of this project is to make a simple and user-friendly photo gallery application, The aim of this project is to make a simple and user-friendly photo gallery application,
that is easy to host on a personal server, to easily view the photos located on that server. that is easy to host on a personal server, to easily view the photos located on that server.
## Main features
- **Closely tied to the file system**. The website presents the images found on the local filesystem of the server, directories are mapped to albums.
- **User management**. Each user is created along with a path on the local filesystem, photos within that path can be accessed by that user.
- **Photo sharing**. Photos and albums can easily be shared with other users or publicly with a unique URL.
- **Made for photography**. The website is ment as a way to present photographies, and thus supports **RAW** file formats, and **EXIF** parsing.
- **Performant**. Thumbnails are automatically generated and photos first load when they are visible on the screen. In full screen, thumbnails are displayed until the high resolution image has been fully loaded.
## Why yet another self-hosted photo gallery ## Why yet another self-hosted photo gallery
There exists a lot of open-source self-hosted photo galleries already. Here are some, just to mention a few. There exists a lot of open-source self-hosted photo galleries already. Here are some, just to mention a few.
@ -41,14 +58,6 @@ Thus I need a solution that can do the following:
All of the photo galleries can do a lot of what I need, but no single one can do it all. All of the photo galleries can do a lot of what I need, but no single one can do it all.
## Main features
- **Closely tied to the file system**. The website presents the images found on the local filesystem of the server, directories are mapped to albums.
- **User management**. Each user is created along with a path on the local filesystem, photos within that path can be accessed by that user.
- **Photo sharing**. Photos and albums can easily be shared with other users or publicly with a unique URL.
- **Made for photography**. The website is ment as a way to present photographies, and thus supports **RAW** file formats, and **EXIF** parsing.
- **Performant**. Thumbnails are automatically generated and photos first load when they are visible on the screen. In full screen, thumbnails are displayed until the high resolution image has been fully loaded.
## Getting started - Setup with Docker ## Getting started - Setup with Docker
> This section describes how to get PhotoView up and running on your server with Docker. > This section describes how to get PhotoView up and running on your server with Docker.