https://github.com/nickjer/django-chat

A personal Django educational project to help me better understand the MVC framework.
https://github.com/nickjer/django-chat

Last synced: about 2 months ago
JSON representation

A personal Django educational project to help me better understand the MVC framework.

• Host: GitHub
• URL: https://github.com/nickjer/django-chat
• Owner: nickjer
• Created: 2014-06-30T03:18:17.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-15T05:16:37.000Z (over 10 years ago)
• Last Synced: 2023-08-01T05:12:16.664Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 238 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
django-chat

===========

A terrible chat application to help me better explore the django framework.

## Key features

* AJAX support for realtime updates

* Nothing else so far, since this is an educational tool for myself...

## Installation

In order to install copy over the "chat" directory from GitHub.

Add `chat` to your `INSTALLED_APPS`:

    INSTALLED_APPS = (

        ...

        'chat',

        ...

    )

Hook this app into your ``urls.py``:

    urlpatterns = patterns('',

        ...

        url(r'^your-url/$', include('chat.urls', namespace="chat")),

        ...

    )

Run `python manage.py migrate` to create the chat models.

Start the development server and visit http://127.0.0.1:8000/chat/ to participate in the chat.

## Usage

This Chat app provides a simple template tag and override-able template that does the work of integrating the chat CSS, JavaScript, and HTML into your site.

To place the chat widget in a template, simply insert the following within it:

    {% load chat %}

    {% show_chat %}

## Customization

This chat app is designed to be customizable.

The chat template tag optionally takes the argument the name of the template to load and override the default template:

    {% load chat %}

    {% show_chat 'your_template.html' %}

A custom template can extend from the master chat template chat/chat.html. There are several blocks which may be overridden for the purpose of customization. For instance, one could got about adding a more up to date JQuery library or plugging in a new CSS layout:

    # your_template.html

    {% extends 'chat/chat.html' %}

    

    {% block jquery_js %}

        

    {% endblock %}

    

    {% block chat_css %}

        

    {% endblock %}

or you can simply replace the static files themselves.

## Versions

This is the only version.

- all versions require Python3

- all versions require Django1.6 (not tested below)