https://github.com/synw/django-rechat

A chat application for Django
https://github.com/synw/django-rechat

django-instant

Last synced: about 1 month ago
JSON representation

A chat application for Django

• Host: GitHub
• URL: https://github.com/synw/django-rechat
• Owner: synw
• License: mit
• Created: 2016-08-13T15:22:18.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-03-08T13:17:04.000Z (over 2 years ago)
• Last Synced: 2024-09-28T12:17:08.147Z (about 2 months ago)
• Topics: django-instant
• Language: Python
• Homepage:
• Size: 139 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Django Rechat

Chat application for Django using websockets

## Install

```

pip install django-rechat

```

Add `"rechat"` and `"instant"` to `INSTALLED_APPS` in settings and update `urls.py`:

```python

urlpatterns = [

    # ...

    path("instant/", include("instant.urls")),

    path("rechat/", include("rechat.urls")),

]

```

Install the websockets server: [quickstart](https://github.com/synw/django-instant#install-the-websockets-server)

Create chat rooms in the admin

## Usage

An Alpinejs frontend is available. To use the rechat templates create your own index template

(here with Tailwind css classes):

```django

{% extends "base.html" %}

{% block content %}

{% include "rechat/init.html" %}



  


    Loading rooms ..

  

  


    
Select a chatroom

  



{% endblock %}

```


## Example project

A runnable [example project](https://github.com/synw/django-rechat-example) is available 

## Todo

- [x] Add a persistence layer option

- [x] Group level authorizations and rooms

- [ ] Rate limits

- [ ] Channel admin, kick/ban

- [ ] Add a presence widget to show users in the chat