Files
Pinry/README.md

96 lines
3.6 KiB
Markdown
Raw Normal View History

# ![Pinry](https://github.com/overshard/pinry/raw/master/logo.png)
2012-04-26 15:47:42 +00:00
2012-05-10 04:52:47 +00:00
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.
2012-04-26 15:47:42 +00:00
2012-04-26 19:04:52 +00:00
![Pinry Screenshot](https://github.com/overshard/pinry/raw/master/screenshot.png)
2012-04-26 18:49:31 +00:00
## Why?
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.
2012-04-26 18:49:31 +00:00
## Getting Started
2012-04-26 15:47:42 +00:00
Pinry has three different customizable configurations:
### Development
2012-04-26 15:47:42 +00:00
Have virtualenv and pip installed. You may also need to have the build
dependencies for PIL installed.
2012-04-26 15:47:42 +00:00
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
2012-04-26 15:47:42 +00:00
$ cd pinry
$ virtualenv .
$ bin/pip install -r requirements/development.txt
2012-04-26 15:47:42 +00:00
$ 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.
2012-05-10 05:06:33 +00:00
## Roadmap
+ Non-image URL pinning
+ Bookmarklet
+ Tagging, groups, multiple and/or user boards
+ Statistics/analytics with pretty graphs
## As Seen On
2012-05-09 01:52:42 +00:00
+ [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)
2012-05-09 01:52:42 +00:00
2012-05-10 05:12:40 +00:00
## License (Simplified BSD)
2012-05-10 05:06:33 +00:00
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.
2012-04-26 18:49:31 +00:00
[0]: http://pinterest.com/
[1]: http://www.wookmark.com/
[2]: https://www.google.com/search?q=deploy+django+production