django-musette

============== Django-Musette

.. image:: https://coveralls.io/repos/mapeveri/django-musette/badge.svg :target: https://coveralls.io/r/mapeveri/django-musette

.. image:: https://travis-ci.org/mapeveri/django-musette.svg?branch=master :target: https://travis-ci.org/mapeveri/django-musette

.. image:: https://badge.fury.io/py/django-musette.svg :target: http://badge.fury.io/py/django-musette

Forum for Django framework. This reusable application it is designed to be easily integrated into an existing Django application.

Features

• Multiple forums ordered by for category.
• Support to sub-forums.
• Count views for forum and topic.
• Support to topics main in forum.
• Support to rss to forums.
• User registration a forum.
• Search topics in a forum.
• Pre-moderation of topics with multiple moderators.
• Support of media files for topics.
• Infinite scroll for comments of one topic.
• Notifications and email notifications.
• Notifications and comments in real time.
• Integrated model profile.
• Avatar profile.
• Easy integration with other applications Django of your project.
• Models registered in admin django for administrators.
• Support check user online.
• Support to English, Italian and Spanish languages.
• Validation of forms in real time with VueJs.
• API REST with django-rest-framework.
• Support Python 3.
• Custom configuration css.
• Markdown support in textarea.
• Authentication.
• Message for forums.
• Suggested Topics in topic.
• Close topic.
• Support to custom user model.
• Support to likes in topics and comments.
• Check if a user is a troll.
• Support Open Graph.

Note 1: When a new record is added to the user model automatically added to your model profile.

Configuration and installation

Documentation_ for installation and configuration

.. _Documentation: https://github.com/mapeveri/django-musette/blob/master/docs/configuration.rst

How to use?

• Login in django admin and start to insert categories necessary. Example:

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/categories.png

The field position is for indicate the order of the categories.

• Insert the forum necessary: Example:

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/forums.png

Field more importants:

- Position: The field position is for indicate the order of the forums in the categories.
- Topics count: Total forum topics.
- Check topics: If you need to review the topics by a moderator.

3. Add record to Model Configuration and configurate the forum (Css styles, logo forum, etc).

• Make sure that each user registration exist in the profile table. Execute in the terminal::

  python manage.py runserver

Visit 127.0.0.1:8000/forums you should see the categories and forums.

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/index.png

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/forum.png

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/notifications.png

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/topic.png

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/new_comment.png

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/comment.png

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/new_topic.png

.. image:: https://github.com/mapeveri/django-musette/blob/master/images/edit_topic.png

Roadmap

Roadmap_ with content of the next versions of django-musette.

.. _Roadmap: https://github.com/mapeveri/django-musette/blob/master/roadmap.rst

Contribute

• Fork this repo and install it
• Follow PEP8, Style Guide for Python Code
• Write code
• Write unit test
• Send pull request