Isaac Bythewood
11 years ago
1 changed files with 18 additions and 102 deletions
Split View
Diff Options
-
+18 -102README.md
+ 18
- 102
README.md
View File
| @@ -1,111 +1,27 @@ | |||
| #  | |||
| [](http://travis-ci.org/overshard/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. | |||
| Pinry is a private, self-hosted, [Pinterest][0] inspired by [Wookmark][1] and | |||
| built on top of Django. Pinry is currently in Alpha/Development, some upgrades | |||
| may be ugly/not work till I release v1.0.0. | |||
| For more information including docs, a tour, and even hosted instances please | |||
| visit [getpinry.com](http://getpinry.com/) | |||
|  | |||
| ## License (GNU AFFERO GENERAL PUBLIC LICENSE) | |||
| ## Why? | |||
| Pinry, an open source image board. | |||
| Copyright (C) 2013 Pinry Contributors | |||
| Mostly because I don't like sharing, I use pinup boards for personal inspiration | |||
| boards. Also if I use a public platform like Pinterest or Wookmark then my pins | |||
| run the risk of getting a DMCA take down notice. I might not even be able to | |||
| pin something at all with websites now blocking tools like this. I rather | |||
| bypass all these risks and just host it myself. | |||
| This program is free software: you can redistribute it and/or modify | |||
| it under the terms of the GNU Affero General Public License as published by | |||
| the Free Software Foundation, either version 3 of the License, or | |||
| (at your option) any later version. | |||
| This program is distributed in the hope that it will be useful, | |||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| GNU Affero General Public License for more details. | |||
| ## Getting Started | |||
| Pinry has two different customizable configurations: | |||
| ### Development | |||
| Have virtualenv and pip installed. You may also need to have the build | |||
| dependencies for PIL installed. | |||
| Note: On Ubuntu you can get the build deps by running | |||
| `sudo apt-get build-dep python-imaging`. | |||
| $ git clone git://github.com/overshard/pinry.git | |||
| $ cd pinry | |||
| $ virtualenv . | |||
| $ bin/pip install -r requirements.txt | |||
| $ bin/python manage.py syncdb | |||
| $ bin/python manage.py migrate | |||
| $ bin/python manage.py runserver | |||
| ### Production | |||
| If you want a production server [Google around][2] for more information on | |||
| running Django in a production environment and edit the | |||
| `pinry/settings/production.py` file. I don't cover this because there are | |||
| hundreds of different ways to deploy a Django project and everyone has their own | |||
| preference. | |||
| ### Quick Settings | |||
| There are a few settings provided specific to Pinry that allow you to get some | |||
| of the most requested functionality easily. | |||
| + **SITE_NAME**: For quickly changing the name Pinry to something you prefer. | |||
| + **ALLOW_NEW_REGISTRATIONS**: Set to False to prevent people from registering. | |||
| + **PUBLIC**: Set to False to require people to register before viewing pins. | |||
| (Note: Setting PUBLIC to False does still allow registrations. Make sure | |||
| both PUBLIC and the previous setting are set to False to prevent | |||
| all public access.) | |||
| ## Roadmap | |||
| + Non-image URL pinning | |||
| + Bookmarklet | |||
| + Tagging, groups, multiple and/or user boards | |||
| + Statistics/analytics with pretty graphs | |||
| ## As Seen On | |||
| + [USA Today](http://www.usatoday.com/tech/products/story/2012-04-27/pinterest-pinry-private-pinning/54584308/1) | |||
| + [Hacker News](http://news.ycombinator.com/item?id=3895618) | |||
| + [The Next Web](http://thenextweb.com/apps/2012/04/27/pinry-is-a-self-hosted-version-of-pinterest-that-gives-you-full-control-of-your-pins/) | |||
| + [Python Weekly](http://us2.campaign-archive2.com/?u=e2e180baf855ac797ef407fc7&id=1f8c766c90&e=292d864a00) | |||
| + [Pycoder's Weekly](http://us4.campaign-archive1.com/?u=9735795484d2e4c204da82a29&id=4f9b37c501) | |||
| ## License (Simplified BSD) | |||
| Copyright (c) Isaac Bythewood | |||
| All rights reserved. | |||
| Redistribution and use in source and binary forms, with or without | |||
| modification, are permitted provided that the following conditions are met: | |||
| 1. Redistributions of source code must retain the above copyright notice, | |||
| this list of conditions and the following disclaimer. | |||
| 2. Redistributions in binary form must reproduce the above copyright notice, | |||
| this list of conditions and the following disclaimer in the documentation | |||
| and/or other materials provided with the distribution. | |||
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | |||
| ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |||
| WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |||
| DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR | |||
| ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |||
| (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | |||
| LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | |||
| ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |||
| (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |||
| SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |||
| [0]: http://pinterest.com/ | |||
| [1]: http://www.wookmark.com/ | |||
| [2]: https://www.google.com/search?q=deploy+django+production | |||
| You should have received a copy of the GNU Affero General Public License | |||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | |||