Spirit

Spirit is a Python based forum built using the Django framework.

To see it in action, please visit The Spirit Project.

Requirements

Python 2.7, 3.3 or 3.4 (recommended)
Django 1.8 LTS
PostgreSQL (recommended) or MySQL or Oracle Database

Dependencies

Check out the requirements provided.

Installing (Advanced)

Check out the example provided.

In short:

Add url(r'^', include('spirit.urls')), to your urls.py

Add from spirit.settings import * to the top of your settings.py file, otherwise you will have to setup all django's related constants (Installed_apps, Middlewares, Login_url, etc)

Run:

pip install -r requirements.txt
python manage.py spiritinstall

You will need to setup a search engine, Spirit is configured to work with Woosh by default.

An email server is required, you can host your own (ie: exim), or hire an external service provider (ie: Mandrill).

Start a development server:

python manage.py runserver

Visit (http://127.0.0.1:8000/)

On production, you would rather run Spirit on a real web server. ie: gunicorn + Nginx. Running Spirit on a virtualenv is adviced.

Upgrading

Detailed upgrade instructions are listed in Upgrading Spirit

Testing

The runtests.py script enable you to run the test suite of spirit.

Type ./runtests.py to run the test suite using the settings from the spirit folder.
Type ./runtests.py example to run the test suite using the settings from the example folder.

License

MIT

2.3 KiB Raw Blame History