Skip to content

Commit

Permalink
Update README.md and INSTALLATION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
basilfx committed Jul 25, 2017
1 parent f99b477 commit f287834
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
4 changes: 2 additions & 2 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Installation
This application has been tested on Ubuntu 17.04 and macOS 10.12.s
This application has been tested on Ubuntu 17.04 and macOS 10.12.

## Development
There are several ways to run Photod for development. During development, a separate Webpack development server will serve the `bundle.js` file via `http://localhost:8000`. The Django development server will serve via http://localhost:7000.
Expand Down Expand Up @@ -34,7 +34,7 @@ docker run --rm -ti -p 8000:8000 -u `id -u` -v `pwd`:`pwd` -w `pwd` photod:lates
The recommended setup is using Nginx, uWSGI, PostgreSQL and Redis.

### Configuring Nginx
Use the optimizations below to speed-up the transfer of resources. This will enable serving of pre-compressed GZIP files (if available) and use X-Accel to offload the uWSGI workers for transferring files.
Use the optimizations below to speed-up the transfer of resources. This will enable serving of pre-compressed GZIP files (if available) and use `X-Accel` to offload the uWSGI workers for transferring static files.

```nginx
server {
Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,21 @@ This project started as a *private* alternative to Google Photos, using the late

There is a backend that is based on the Django Web Framework. It also provided the command-line interface for enrolling and processing of media files. The frontend is based on Webpack, React and UIkit.

A very basic mobile interface is available.

## Features
Some of the included features:

* Image and video gallery.
* Face detection and OCR.
* Film strips previews (like YouTube).
* Full-text search (depending on backend).
* Geocoding (requires Mapzen API key).
* WebP image encoding for fast image transfer, with JPEG fallback.
* Color classification.
* User authentication.
* Share images using public links.

## Screenshots
<img src="https://raw.githubusercontent.com/basilfx/Photod/master/docs/screenshots/login.png" width="256"><img src="https://raw.githubusercontent.com/basilfx/Photod/master/docs/screenshots/directories1.png" width="256"><img src="https://raw.githubusercontent.com/basilfx/Photod/master/docs/screenshots/directories2.png" width="256"><img src="https://raw.githubusercontent.com/basilfx/Photod/master/docs/screenshots/tags.png" width="256"><img src="https://raw.githubusercontent.com/basilfx/Photod/master/docs/screenshots/map.png" width="256"><img src="https://raw.githubusercontent.com/basilfx/Photod/master/docs/screenshots/search.png" width="256"><img src="https://raw.githubusercontent.com/basilfx/Photod/master/docs/screenshots/about.png" width="256">

Expand Down

0 comments on commit f287834

Please sign in to comment.