pinry

winkidney 2278d6a552 Feature: Support local_settings as optional settings		vor 6 Jahren
core	Fix: Fix permission check for tastypie / update to 0.14.1	vor 6 Jahren
django_images	Fix: Add migration file for lastest version of django_images	vor 6 Jahren
doc	Doc: Change removing of migration-file to optional	vor 6 Jahren
pinry	Feature: Support local_settings as optional settings	vor 6 Jahren
users	Fix: Fix permission check for tastypie / update to 0.14.1	vor 6 Jahren
.gitignore	Feature: Use docker-compose example file instead of compose-file	vor 6 Jahren
.travis.yml	Update travis config	vor 6 Jahren
Dockerfile	Feature: Use docker-compose example file instead of compose-file	vor 6 Jahren
LICENSE	Update license to 2018 and plaintext	vor 6 Jahren
Makefile	Feature: Add backup/install/test commands in Makefile	vor 6 Jahren
Pipfile	Fix: Fix permission check for tastypie / update to 0.14.1	vor 6 Jahren
Pipfile.lock	Fix: Fix permission check for tastypie / update to 0.14.1	vor 6 Jahren
README.rst	Feature: Add doc for topic "upgrade from 1.x to 2.x"	vor 6 Jahren
docker-compose.example.yml	Refactor: Use stdout as the log-output	vor 6 Jahren
logo.png	Updated requirements and other items in preps of new pinry version	vor 11 Jahren
manage.py	Fix: Add a mark 'IS_TEST' to decide if we should load image-urls	vor 6 Jahren
start_docker_with_current_user.sh	Fix: Fix non-effect env	vor 6 Jahren

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`_.


Upgrade from 1.x
------------------

For source code users:

Read our `online doc <doc/upgrade_from_1.x.md>`_ about how to upgrade to 2.x

For docker users, please contact us for help: )

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 ``Pipfile`` file. You can easily install
these using pipenv, to get pipenv, if you already have Python and pip, run
python ``pip install pipenv``.


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::

    pipenv install --dev --three
    pipenv run python manage.py test


Docker
------

Follow the steps below to install Pinry locally or on any server. This
process installs the minimal requirements to run Pinry. For development
requirements and procedures, see testing above.

- Install the requirements:
    - Docker
    - Docker Compose

- Set any custom configuration options you need and run::

    docker-compose up -d

- Bootstrap the database::

    docker-compose exec web python3 manage.py migrate --settings=pinry.settings.docker


Linting
-------

So everything isn't a mess::

    pipenv run flake8 --exclude=migrations


Contributors
------------

The core contributors for Pinry have been/currently are:

* Isaac Bythewood <http://isaacbythewood.com/>
* Krzysztof Klimonda
* Lapo Luchini <https://github.com/lapo-luchini>

For a full list of contributors check out the `GitHub Contributors Graph`_.


.. Links

.. |Pinry| image:: https://raw.github.com/pinry/pinry/master/logo.png
.. _getpinry.com: http://getpinry.com/
.. _docker-pinry GitHub repository: https://github.com/pinry/docker-pinry
.. _GitHub Contributors Graph: https://github.com/pinry/pinry/graphs/contributors