django-musette 0.0.8

Forum for Django framework.

Forum for Django framework.

NOTE: This application is under development. It is not recommended to use in a production environment.

Installing

pip install django-musette –process-dependency-links

Requirements:

1. Jquery

2. Bootstrap and bootstrap material desing (https://fezvrasta.github.io/bootstrap-material-design/)

3. Angular.js

Quick start:

1. Add application ‘musette’ and dependencies to INSTALLED_APPS:

   INSTALLED_APPS = (
           ...
           'log',
           'hitcount',
           'endless_pagination',
           'musette',
   )

2. Add this urls to file urls.py:

   url(r'^' , include('musette.urls')),

3. And in settings.py add this variable:

   SESSION_SAVE_EVERY_REQUEST = True

4. Configure in the settings.py URL_LOGIN, STATIC and MEDIA root. Something very important is to set the variable CACHES for redis. example:

   CACHES = {
       'default': {
           'BACKEND' : 'redis_cache.RedisCache',
           'LOCATION' : 'localhost:6379',
           'OPTIONS' : {
               'DB' : 1
               }
           }
   }

5. Set this variables:

   APP_PROFILE = 'profiles' # Application for your profiles
   MODEL_PROFILE = 'Profile' # Model for profiles
   FIELD_PHOTO_PROFILE = "photo" # Field that contains url the profile photo
   URL_PROFILE = '/profile/' # Url for profile

6. Execute command migrate:

   python manage.py migrate

7. The application django-musette need a template base of name base.html. With the following tags:

   {% block content %}{% endblock %}
   {% block extra_css %}{% endblock %}
   {% block extra_js %}{% endblock %}
   {% block hitcount_javascript %}{% endblock %}

And add files static css and js (Angular, Jquery, Bootstrap).

Example.

https://github.com/mapeveri/django-musette/blob/master/tests/plantillas/base.html

8. If you need Spanish forum enable internationalization in django.

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

How to use?:

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

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

2. Insert the forum necessary: Example:

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. Make sure that each user registration exist in the profile table.

Ready!

Execute in the terminal:

python manage.py runserver

4. In other terminal execute this command for run server tornado for web sockets:

   python manage.py musette_run_server_ws

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

Features:

1. Multiple forums ordered by for category.

2. Notifications (Still not support sending emails).

3. Notifications in real time.

4. Count views for forum and topic.

5. Infinite scroll for comments of one topic.

6. Support of files media for topics.

7. Easy integration with other applications Django of your project.

8. Support for moderate forums.

9. Models registered in admin django for administrators.

10. Possibility of hide forums unused.

11. Modern design, thank you to Bootstrap material design

12. Avatar.

13. Pre-moderation.

14. Support to English and Spanish language.

15. Validation of forms in real time with AngularJs.

Contribute:

1. Fork this repo and install it

2. Follow PEP8, Style Guide for Python Code

3. Write code

4. Send pull request