Skip to content
This repository has been archived by the owner on Jan 28, 2020. It is now read-only.

Commit

Permalink
add introduction doc
Browse files Browse the repository at this point in the history
  • Loading branch information
EnTeQuAk committed Aug 19, 2012
1 parent 286c64e commit e12f92d
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/index.rst
Expand Up @@ -11,6 +11,8 @@ Contents:
.. toctree::
:maxdepth: 2

introduction



Indices and tables
Expand Down
27 changes: 27 additions & 0 deletions docs/introduction.rst
@@ -0,0 +1,27 @@
Introduction
============

Folivora is your new tool which never lets you forget about package updates.
You define your projects and dependencies and once a new release hits PyPi
Folivora will notify you.

A hosted version is available on `heroku`_ (username/password is demo/demo,
although to get notifications you should register on your own) and you
can try it our yourself (in a venv)::

git clone git://github.com/rocketDuck/folivora.git
cd folivora
pip install -r requirements.txt
python manage.py syncdb

The default settings expect a postgres server on localhost with a database
named folivora (postgres is a requirement due to the usage of hstore). You
also need to run an initial sync with PyPi to fetch the package names::

PYTHONPATH=. DJANGO_SETTINGS_MODULE=example.settings ./extra/sync.py

After that changes are fetched via celery. To run the project use::

foreman start -f Procfile.development

.. _`heroku`: http://folivora.herokuapp.com

0 comments on commit e12f92d

Please sign in to comment.