Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/narrowfail/django-channels-chat
A simple Django-Channels web chat!
https://github.com/narrowfail/django-channels-chat
Last synced: 18 days ago
JSON representation
A simple Django-Channels web chat!
- Host: GitHub
- URL: https://github.com/narrowfail/django-channels-chat
- Owner: narrowfail
- License: mit
- Created: 2018-02-18T22:12:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-29T17:45:18.000Z (4 months ago)
- Last Synced: 2024-07-31T01:14:03.358Z (4 months ago)
- Language: Python
- Size: 860 KB
- Stars: 658
- Watchers: 21
- Forks: 242
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChatApp #
A small functional person-to-person message center application built using Django.
It has a REST API and uses WebSockets to notify clients of new messages and
avoid polling.
## Architecture ##
- When a user logs in, the frontend downloads the user list and opens a
Websocket connection to the server (notifications channel).
- When a user selects another user to chat, the frontend downloads the latest
15 messages (see settings) they've exchanged.
- When a user sends a message, the frontend sends a POST to the REST API, then
Django saves the message and notifies the users involved using the Websocket
connection (sends the new message ID).
- When the frontend receives a new message notification (with the message ID),
it performs a GET query to the API to download the received message.
## Scaling ##
### Requests ###
"Because Channels takes Django into a multi-process model, you no longer run
everything in one process along with a WSGI server (of course, you’re still
free to do that if you don’t want to use Channels). Instead, you run one or
more interface servers, and one or more worker servers, connected by that
channel layer you configured earlier."
In this case, I'm using the In-Memory channel system, but could be changed to
the Redis backend to improve performance and spawn multiple workers in a
distributed environment.
Please take a look at the link below for more information:
https://channels.readthedocs.io/en/latest/introduction.html
**update 04/06/19**
- using pipenv for package management
- move to Channels 2
- use redis as the channel layer backing store. for more information, please check [channels_redis](https://github.com/django/channels_redis)
### Database ###
For this demo, I'm using a simple MySQL setup. If more performance is required,
a MySQL cluster / shard could be deployed.
PD: I'm using indexes to improve performance.
## Assumptions ##
Because of time constraints this project lacks of:
- User Sign-In / Forgot Password
- User Selector Pagination
- Good Test Coverage
- Better Comments / Documentation Strings
- Frontend Tests
- Modern Frontend Framework (like React)
- Frontend Package (automatic lintin, building and minification)
- Proper UX / UI design (looks plain bootstrap)
## Run ##
0. move to project root folder
1. Create and activate a virtualenv (Python 3)
```bash
pipenv --python 3 shell
```
2. Install requirements
```bash
pipenv install
```
3. Create a MySQL database
```sql
CREATE DATABASE chat CHARACTER SET utf8;
```
4. Start Redis Server
```bash
redis-server
```
5. Init database
```bash
./manage.py migrate
```
6. Run tests
```bash
./manage.py test
```
7. Create admin user
```bash
./manage.py createsuperuser
```
8. Run development server
```bash
./manage.py runserver
```
To override default settings, create a local_settings.py file in the chat folder.
Message prefetch config (load last n messages):
```python
MESSAGES_TO_LOAD = 15
```