snippify documentation¶
snippify is a django app that stores code snippets in a social way.
You can find snippify installed at: http://snippify.me/ Get the source: https://github.com/humanfromearth/snippify/
Getting started¶
About snippify¶
Snippify is a web-app for storing online code snippets. It was created and is now maintained by Alexandru Plugaru (sasha at snippify me) to experience Django Web framework goodness. Also the awesome UI designer that made the layout of this website, CSS and a lot of testing is Andrei Zahariade (http://random-pixels.com/) - you’re the best dude :D
Obviously I and probably you need an app like this to store our own recipes.
It started as a simple project for posting snippets with syntax highlighting (thanks Pygments!), but now it’s rather social with a REST interface which can be used using these plugins in different IDE’s and Firefox
The best part of all is that this is a FLOSS project so the code of this website and plugins are freely available on github so feel free to grab it or contribute.
Happy snippifying!
Installation¶
This document assumes that you are familiar with python, django, pip and virtualenv.
Requirements¶
See requirements.txt which is a pip
compatible requirements list.
Installation (unix)¶
This is the long way to install snippify. It is installed as a lot of other
django apps. This is an example based on virtualenv.
virtualenv . --no-site-packages
source bin/activate
pip install -r requirements.txt
cp local_settings.py.sample local_settings.py # Configure this file for your needs
./manage.py syncdb
./manage runserver
At this point you should be able to see a working snippify instance at http://localhost:8000/
Note
Remember to configure your MEDIA_URL correctly.
How to use snippify¶
Put a screencast here
Other¶
Glossary¶
Some terms used in the documentation are described here.
- snippet
- In IT terminology a snippet is a piece of programming code which is usually stored somewhere for later usage. Of course it’s always fun to share with friends your latest uber-cool asm hack which turns a chicken into an egg. This is where snippify comes in handy.
Contributors¶
- Alexandru Plugaru (alexandru.plugaru gmail com)
- Andrei Zahariade (andrei random-pixels com)
