https://github.com/szymon-budziak/webchat_django_chat
"WebChat" a real-time chat application project written in Django, Channels and design along with Tailwind CSS for WebRTC and Secure System Design courses at UNINA
https://github.com/szymon-budziak/webchat_django_chat
chat django django-application django-channels python real-time real-time-applications tailwindcss webrtc
Last synced: about 2 months ago
JSON representation
"WebChat" a real-time chat application project written in Django, Channels and design along with Tailwind CSS for WebRTC and Secure System Design courses at UNINA
- Host: GitHub
- URL: https://github.com/szymon-budziak/webchat_django_chat
- Owner: Szymon-Budziak
- License: mit
- Created: 2022-12-08T22:37:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-10T14:03:51.000Z (about 2 years ago)
- Last Synced: 2025-02-01T02:51:13.721Z (3 months ago)
- Topics: chat, django, django-application, django-channels, python, real-time, real-time-applications, tailwindcss, webrtc
- Language: Python
- Homepage:
- Size: 123 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebChat
"WebChat" a real-time chat application project written in Django, Channels and design along with Tailwind CSS for WebRTC and Secure System Design courses at UNINA.
## The structure of the project
Project consists of 3 main parts:
- **core** directory where is the logic for the main page, login, signup and logout
- **room** directory, inside it there is a logic for rooms and chat where user can join and have a chat with
someone else inside the specific room
- **webchat** directory where are the django initial files that are created while running `django-admin startproject`
command
After running a server (prerequisites are below) we should have such a website where we can sign up or log in:
When we are logged in we can enter rooms:
After entering one of the rooms we can have a chat with other users:
When we log out we are redirected to the main page.
## Prerequisites
Before you start, you have to install all requirements. Installation process on Linux/macOS and Windows:
__1. Clone repository by typing:__
```
git clone https://github.com/Szymon-Budziak/WebChat_django_chat.git
```
__2. Enter `WebChat_django_chat` folder:__
```
cd WebChat_django_chat/
```
__3. Create new virtual environment for this project and activate it:__
- Linux/macOS machine:
```
python -m venv venv
source venv/bin/activate
```
(if python is not working try using python3)
- Windows machine:
```
py -m venv venv
venv\Scripts\activate
```
this will create new activated virtual environment with `venv` name.
__4. Install required packages:__
```
pip install -r requirements.txt
```
If this command is now working, install `django` and `channels` in command line:
```
pip install django channels==3.0.5
```
__5. Enter `webchat` folder and make migrations to create necessary databases for models:__
- Linux/macOS machine:
```
python manage.py migrate
```
(if python is not working try using python3)
- Windows machine:
```
py manage.py migrate
```
__6. Create `superuser` to have access to admin page:__
- Linux/macOS machine:
```
python manage.py createsuperuser
```
(if python is not working try using python3)
- Windows machine:
```
py manage.py createsuperuser
```
Now you are ready to explore Django code and run server, enter dashboard website `http://localhost:8000`:
- Linux/macOS machine:
```
python manage.py runserver
```
(if python is not working try using python3)
- Windows machine:
```
py manage.py runserver
```