Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/urtzai/django-forum-app

A very simple/minimalistic Django Forum app
https://github.com/urtzai/django-forum-app

app django forum python

Last synced: about 2 months ago
JSON representation

A very simple/minimalistic Django Forum app

Awesome Lists containing this project

README

        

Django-forum-app
================

.. image:: https://api.travis-ci.org/urtzai/django-forum-app.svg?branch=master
:target: https://travis-ci.org/urtzai/django-forum-app
:alt: Travis CI

.. image:: https://coveralls.io/repos/github/urtzai/django-forum-app/badge.svg?branch=master
:target: https://coveralls.io/github/urtzai/django-forum-app?branch=master
:alt: Test coverage

.. image:: https://landscape.io/github/urtzai/django-forum-app/master/landscape.svg?style=flat
:target: https://landscape.io/github/urtzai/django-forum-app
:alt: Code health

.. image:: https://img.shields.io/badge/python-2.7-blue.svg
:target: https://badge.fury.io/py/django-forum-app
:alt: Latest Python 2 version

.. image:: https://img.shields.io/badge/python-3.5-blue.svg
:target: https://badge.fury.io/py/django-forum-app
:alt: Latest Python 3 version

.. image:: https://badge.fury.io/py/django-forum-app.svg
:target: https://badge.fury.io/py/django-forum-app
:alt: Latest PyPI version

.. image:: https://requires.io/github/urtzai/django-forum-app/requirements.svg?branch=master
:target: https://requires.io/github/urtzai/django-forum-app/requirements?branch=master
:alt: Package requirements

A very simple/minimalistic Django Forum app based on yoanisgil's `Django simple forum `_ project.

Example
-------

A `production example `_ of this forum app courtesy of Game Erauntsia, basque gamer community

Dependencies
------------

- Django >= 1.10.0
- django-photologue >= 3.6
- django-tinymce >= 2.6.0

Installation
------------

Clone this repository and add it to your ``INSTALLED_APPS`` list:

.. code-block:: python

INSTALLED_APPS = [
'django_forum_app',
]

Then run migrations:

.. code-block::

./manage.py migrate django_forum_app

Finally, add this in ``urls.py``:

.. code-block:: django

url(r'^forum/', include('django_forum_app.urls')),

Settings
--------

Ther are some option you could overrite to change the default behaviour of the forum:

``FORUM_SUBJECT``
Subject for email notifications

**Default:** ``FORUM``

``POSTS_PER_PAGE``
Number of posts shown per page.

**Default:** ``10``

``DJANGO_FORUM_APP_FILTER_PROFANE_WORDS``
Attribute to filter profane words. Values should be ``True | False``

**Default:** ``True``

``TINYMCE_DEFAULT_CONFIG``
Overriding this option you can change the tinymce editor behaviour.

**Default:**

.. code-block:: python

TINYMCE_DEFAULT_CONFIG = {
'language': 'en',
'theme': 'modern',
'height': 600,
'plugins': [
'advlist autolink lists link image charmap print preview anchor',
'searchreplace visualblocks code fullscreen',
'insertdatetime media table contextmenu paste',
],
'toolbar': 'styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image media | code preview',
'menubar': False,
'media_alt_source': False,
'media_poster': False,
'media_dimensions': False,
}

Support
-------

Should you experience any issues do not hesistate to post an issue or contribute in this project pulling requests.

Travis CI status
----------------

We use Travis to check that the unit test suite is working against various combinations of Python, Django, etc...
`Click here for the full report `_.