Metadata-Version: 1.1
Name: django-musette
Version: 0.0.7
Summary: Forum for Django framework.
Home-page: https://github.com/mapeveri/django-musette
Author: Peveri Martin
Author-email: martinpeveri@gmail.com
License: BSD License
Description: ==============
        Django-Musette
        ==============
        
        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.
        
        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:
        
        .. image:: https://github.com/mapeveri/django-musette/blob/master/images/categories.png
        
        The field position is for indicate the order of the categories.
        
        2. 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. Make sure that each user registration exist in the profile table.
        
        Ready!
        
        
        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_topic.PNG
        
        Features:
        ---------
        
        1. Multiple forums ordered by for category.
        2. Notifications (Still not support sending emails)
        3. Count views for forum and topic.
        4. Infinite scroll for comments of one topic.
        5. Support of files media for topics.
        6. Easy integration with other applications Django of your project.
        7. Support for moderate forums.
        8. Models registered in admin django for administrators.
        9. Possibility of hide forums unused.
        10. Modern design, thank you to Bootstrap material design
        11. Avatar.
        12. Pre-moderation.
        13. Support to English and Spanish language.
        14. 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
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
