pinry

Isaac Bythewood 251dbb84a7 Remove broken chrome extension from README		pirms 8 gadiem
pinry	Setup development allowed hosts to be a wildcard, move wsgi and delete bootstrap	pirms 8 gadiem
.bowerrc	Use bower to handle js vendor dependencies	pirms 8 gadiem
.gitignore	Use bower to handle js vendor dependencies	pirms 8 gadiem
CONTRIBUTORS.rst	Add me to contriutors and reference the Chrome extension (as suggested in #67).	pirms 10 gadiem
LICENSE.rst	Moving to RST to be more pythonic	pirms 11 gadiem
README.rst	Remove broken chrome extension from README	pirms 8 gadiem
bower.json	Reimplement image uploading	pirms 8 gadiem
logo.png	Updated requirements and other items in preps of new pinry version	pirms 11 gadiem
manage.py	Initial commit.	pirms 12 gadiem
requirements.txt	Pinry breaks with Django 1.9, not allowing till fixed.	pirms 8 gadiem

README.rst

|Pinry|
=======

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``)

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.

.. Links

.. |Pinry| image:: https://raw.github.com/pinry/pinry/master/logo.png
.. |Codeship Status for pinry/pinry| image:: https://www.codeship.io/projects/461ebc50-70be-0130-073a-22000a9d07d8/status?branch=master
:target: https://www.codeship.io/projects/2005
.. _getpinry.com: http://getpinry.com/
.. _Read the Docs: http://pinry.readthedocs.org/
.. _docker-pinry GitHub repository: https://github.com/pinry/docker-pinry
.. _chrome-pinry GitHub repository: https://github.com/lapo-luchini/chrome-pinry
.. _Pinry Chrome extension: https://chrome.google.com/webstore/detail/pinry-chrome/jmhdcnmfkglikfjafdmdikoonedgijpa