Skip to content

Commit 060b5bd

Browse files
committed
feat : readme and demo.mp4
1 parent 042cf2d commit 060b5bd

File tree

6 files changed

+96
-0
lines changed

6 files changed

+96
-0
lines changed

.DS_Store

0 Bytes
Binary file not shown.

Readme.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
```markdown
2+
# Faiz-Z Tech Task
3+
4+
This repository contains a Django WebSocket server and a React client for a real-time chat application.
5+
6+
## Setup Instructions
7+
8+
### Clone the Repository
9+
10+
To get started, clone the repository to your local machine:
11+
12+
```sh
13+
git clone https://github.com/Faizgeeky/Faiz-Z_Tech-Task.git
14+
cd Faiz-Z_Tech-Task
15+
```
16+
17+
### Setting Up the Django WebSocket Server
18+
19+
1. Navigate to the `server` folder:
20+
```sh
21+
cd server
22+
```
23+
24+
2. Install the required dependencies:
25+
```sh
26+
pip install -r requirements.txt
27+
```
28+
29+
3. Run the Daphne server:
30+
```sh
31+
daphne -p 8000 server.asgi:application
32+
```
33+
34+
### Setting Up the React Client
35+
36+
1. Navigate to the `client` folder:
37+
```sh
38+
cd ../client
39+
```
40+
41+
2. Install the required dependencies:
42+
```sh
43+
npm install
44+
```
45+
46+
3. Start the React application:
47+
```sh
48+
npm start
49+
```
50+
51+
### Demonstration Video
52+
53+
Watch the demonstration video below to see the application in action:
54+
55+
[Download Demo Video](https://github.com/Faizgeeky/Faiz-Z_Tech-Task/raw/main/demo.mp4)
56+
57+
### How the Application Works
58+
59+
This project uses Django Rest Framework (DRF) APIs and Django Channels to build a real-time chat application.
60+
61+
### Postman Collection
62+
63+
A `collection.json` file is included for easy testing of the API endpoints with Postman. Simply import this file into Postman to get started.
64+

demo.mp4

17.3 MB
Binary file not shown.

server.zip

-49.8 KB
Binary file not shown.

server/.DS_Store

0 Bytes
Binary file not shown.

server/requirements.txt

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
asgiref==3.8.1
2+
attrs==23.2.0
3+
autobahn==23.6.2
4+
Automat==22.10.0
5+
cffi==1.16.0
6+
channels==4.1.0
7+
channels-redis==4.2.0
8+
constantly==23.10.4
9+
cryptography==42.0.8
10+
daphne==4.1.2
11+
Django==5.0.6
12+
django-channels-jwt==0.0.3
13+
django-cors-headers==4.4.0
14+
djangorestframework==3.15.2
15+
djangorestframework-simplejwt==5.3.1
16+
hyperlink==21.0.0
17+
idna==3.7
18+
incremental==22.10.0
19+
msgpack==1.0.8
20+
pyasn1==0.6.0
21+
pyasn1_modules==0.4.0
22+
pycparser==2.22
23+
PyJWT==2.8.0
24+
pyOpenSSL==24.1.0
25+
redis==5.0.7
26+
service-identity==24.1.0
27+
six==1.16.0
28+
sqlparse==0.5.0
29+
Twisted==24.3.0
30+
txaio==23.1.1
31+
typing_extensions==4.12.2
32+
zope.interface==6.4.post2

0 commit comments

Comments
 (0)