QingdaoU/Spirit
1
0
Fork 0
mirror of https://github.com/QingdaoU/Spirit.git synced 2024-12-29 07:51:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Spirit is a modern Python based forum built on top of Django framework
472 Commits 9 Branches 18 Tags 18 MiB
Python 54.5%
HTML 14%
CSS 12.9%
CoffeeScript 10.1%
SCSS 6.4%
Other 2.1%
0a04050d07
Go to file
nitely 0a04050d07 gulp coffescript maps
2015-10-06 02:32:28 -03:00
.tx .tx config change apps ids to using project_slug.resource_slug 2015-07-31 02:25:46 -03:00
example Readme installation spiritinstall command 2015-08-02 18:07:36 -03:00
spirit gulp coffescript maps 2015-10-06 02:32:28 -03:00
.editorconfig Check pep8 with travis 2014-11-17 15:03:39 +01:00
.gitattributes gitattributes LF 2014-11-17 21:26:41 -03:00
.gitignore gulp & styles refactor 2015-10-06 02:32:27 -03:00
.travis.yml travis no sudo 2015-09-06 12:23:44 -03:00
gulpfile.js gulp coffescript 2015-10-06 02:32:28 -03:00
HISTORY.md bump 0.4.2 2015-08-14 19:19:41 -03:00
LICENSE license 2015-06-10 10:16:53 -03:00
MANIFEST.in broken setup #4 2014-05-18 20:37:30 -03:00
package.json gulp coffescript 2015-10-06 02:32:28 -03:00
README.md readme Requirements -> Compatibility 2015-09-23 19:45:32 -03:00
requirements.txt update dependencies 2015-07-28 00:12:56 -03:00
runtests.py tests cleanup 2015-07-25 00:17:53 -03:00
setup.cfg Fix F841 errors of unused local variables 2014-11-29 21:08:08 +01:00
setup.py bump 0.4.2 2015-08-14 19:19:41 -03:00
TODO todo 2015-05-05 13:11:32 -03:00

README.md

Spirit

Build Status Coverage Status pypi licence

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

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

Compatibility

  • Python 2.7, 3.3 and 3.4 (recommended)
  • Django 1.8 LTS
  • PostgreSQL (recommended), MySQL, Oracle Database and SQLite

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 django-spirit
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