Getting Started

This is a guide that will get you started with Froide in no time. Some more advanced features are discussed at the end.

Set up the development environment

You should be using virtualenv and it is suggested you also use virtualenvwrapper. Setup a virtual environment for development like so:

mkvirtualenv --no-site-packages froide

Get the source code with Git from the official GitHub repository or from your fork:

git clone git://
cd froide

Install the requirements inside the virtual env with pip:

which pip
<should display your virtual env pip>
pip install -r requirements.txt

If only your global pip is available, run easy_install pip. The dependency installation takes a couple of seconds, but after that everything is in place.

Copy to

cd froide

The development environment uses SQLite. You can change that in, if you want, but you don’t have to. Sync and migrate and do NOT create a superuser just yet:

python syncdb --noinput --migrate

Now you can create a superuser account:

python createsuperuser

That’s it for a setup that basically works. Run this:

python runserver

and go to http://localhost:8000. You should be greeted by a working Froide installation. It doesn’t have any data inside, but you can change that by going to http://localhost:8000/admin/ and logging in with your superuser account.

For more information on the different models you find in the admin visit Froide Data Model.

Run tests

Froide has a test suite. Copy to does not import your changes.

You can then run the shell script for tests:


This also does timing and a test coverage analysis that you can then find at htmlcov/index.html. Note some tests will not work without a search engine like solr running.

Search with Haystack and Solr

Background Processing with Celery

Project Versions

Table Of Contents

Previous topic


Next topic

Froide Data Model

This Page