pinry/README.md

The open-source core of Pinry, a tiling image board system for people who want to save, tag, and share images, videos and webpages in an easy to skim through format.

For more information and a working demo board visit getpinry.com.

For the latest documentation check out Read the Docs.

Requirements

Pinry is built on top of Django and optimized to run on a Linux environment. However we have gotten Pinry to work on Windows and Mac as well but it may require some extra digging around configuration. Pinry’s Python requirements are all in the requirements.txt file and easily installable once you have up a virtual environment. What you need initially:

• Python
• pip
• virtualenv
• Your OS’s build tools (Ubuntu: build-essential, Mac: Xcode)
• Build dependencies for PIL/Pillow (Ubuntu: apt-get build-dep python-imaging)

After you have all of the above you can skip to Testing and make sure it all works.

Testing

We have many tests built into Pinry to ensure that changes don’t break anything. If you are live dangerously and have cutting edge new Pinry features first you can use our master branch for your own instance. We recommend using our tags/versions though.

To run Pinry’s tests inside the Pinry repo run:

virtualenv .
bin/pip install -r requirements.txt
bin/python manage.py test

Production Deployment

Our supported and suggested way to deploy Pinry is using Docker. We provide support and instructions for that over at the docker-pinry GitHub repository.

If you’d like a different setup then check out the hundreds of tutorials for production Django deployment found via Google.

Current Master Build Status