Skip to content

Commit f5908c3

Browse files
author
Mohd Irfan
committed
readme changed
1 parent 299f732 commit f5908c3

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# DevStudy - A chat room for developers
2+
3+
## Description
4+
5+
DevStudy is a chat room for developers to discuss about programming languages, frameworks, libraries, etc. It is a place where developers can share their knowledge and learn from each other.
6+
7+
## Features
8+
9+
- [x] User can sign up and sign in with email and password
10+
- [x] User can sign in with Google account
11+
- [x] User can create a new room
12+
- [x] User can join a room
13+
- [x] User can send messages in a room
14+
- [x] User can see the list of rooms (home feed)
15+
- [x] User can see the list of members in a room (all participants)
16+
17+
## Technologies
18+
19+
- Django
20+
- Django REST Framework
21+
- HTML
22+
- CSS
23+
- JavaScript
24+
25+
## Installation
26+
27+
1. Clone the project to your local directory
28+
29+
```bash
30+
git clone
31+
```
32+
33+
2. Create a virtual environment
34+
35+
```bash
36+
python -m venv venv
37+
```
38+
39+
3. Activate the virtual environment
40+
41+
```bash
42+
.\venv\Scripts\activate
43+
```
44+
45+
4. Install the dependencies
46+
47+
```bash
48+
pip install -r requirements.txt
49+
```
50+
51+
5. Run the server
52+
53+
```bash
54+
python manage.py runserver
55+
```
56+
57+
## License
58+
59+
[MIT](https://choosealicense.com/licenses/mit/)
60+
```

0 commit comments

Comments
 (0)