1
0
mirror of https://github.com/xuthus83/pigallery2.git synced 2024-11-03 21:04:03 +08:00
pigallery2/README.md

51 lines
2.6 KiB
Markdown
Raw Normal View History

2016-03-12 19:46:42 +08:00
# PiGallery2
2016-03-13 23:07:58 +08:00
[![Build Status](https://travis-ci.org/bpatrik/PiGallery2.svg?branch=master)](https://travis-ci.org/bpatrik/PiGallery2)
2016-03-13 23:09:59 +08:00
[![Coverage Status](https://coveralls.io/repos/github/bpatrik/PiGallery2/badge.svg?branch=master)](https://coveralls.io/github/bpatrik/PiGallery2?branch=master)
2016-05-02 16:07:42 +08:00
[![Heroku](https://heroku-badge.herokuapp.com/?app=pigallery2&style=flat)](https://pigallery2.herokuapp.com)
2016-03-12 21:34:44 +08:00
[![Code Climate](https://codeclimate.com/github/bpatrik/PiGallery2/badges/gpa.svg)](https://codeclimate.com/github/bpatrik/PiGallery2)
2016-03-12 21:21:56 +08:00
[![Dependency Status](https://david-dm.org/bpatrik/PiGallery2.svg)](https://david-dm.org/bpatrik/PiGallery2)
2016-03-12 21:21:25 +08:00
[![devDependency Status](https://david-dm.org/bpatrik/PiGallery2/dev-status.svg)](https://david-dm.org/bpatrik/PiGallery2#info=devDependencies)
2017-03-23 02:38:39 +08:00
This is a directory-first photo gallery website, optimised for running on low resource servers (especially on raspberry pi)
2016-03-14 20:30:15 +08:00
2017-03-23 02:38:39 +08:00
Work in progess.... Estimated first beta in 2017 summer
2016-03-14 20:30:15 +08:00
Live Demo @ heroku: https://pigallery2.herokuapp.com/
2017-03-23 02:38:39 +08:00
Feature list:
* **Rendering directories as it is**
* Listing subdirectories recursively
* Listing photos in a nice grid layout
* supporting most common image formats
* showing **tag/keywords, locations, GPS coordinates** for photos
* rendering photos on demand (on scroll)
2017-03-23 02:41:32 +08:00
* **On the fly thumbnail generation** in several sizes
2017-03-23 02:38:39 +08:00
* prioritizes thumbnail generation (generating thumbnail first for the visible photos)
* saving generated thumbnails to TEMP folder for reuse
* supporting several core CPU
* supporting hardware acceleration ([sharp](https://github.com/lovell/sharp) as optional and JS-based [Jimp](https://github.com/oliver-moran/jimp) as fallback)
2017-03-23 02:38:39 +08:00
* Custom lightbox for full screen photo viewing
* keyboard support for navigation - `In progress`
* showing low-res thumbnail while full image loads
* Information panel for showing **Exif info** - `In progress`
2017-03-23 02:41:32 +08:00
* Client side caching (directories and search results)
2017-03-23 02:38:39 +08:00
* Rendering **photos** with GPS coordinates **on google map**
* .gpx file support - `In progress`
2017-03-23 02:41:32 +08:00
* **Two modes: SQL database and no-database mode**
* both modes supports
* user management
* password protection can be disabled/enabled
2017-03-23 02:38:39 +08:00
* database mode supports:
* faster directory listing
* searching
* instant search, auto complete
* sharing - `In progress`
* setting link expiration time
* Nice design - `In progress`
* responsive design (phone, tablet desktop support)
* Setup page - `In progress`
* **Markdown based blogging support** - `In progress`
2017-03-23 02:41:32 +08:00
* you can write some note in the blog.md for every directory
2017-03-23 02:38:39 +08:00
* bug free :) - `In progress`