Merge pull request #1 from dev-mdirfan/studybuddy

DevStudy v0.5 and v1.0 added

Author: dev-mdirfan

.gitignore

@@ -1,4 +1,9 @@
-/studybud/env
-/backend/studybud/env
+# /studybud/env
+# /backend/studybud/env
+
+env/
+*env/
+venv/
+*venv/
 
 

README.md

@@ -1,151 +1,60 @@
-# Study Buddy - Chat Room Application
-
-<div align="center">
-<img width="30%" src="https://github.com/dev-mdirfan/StudyBuddy_chat_application/assets/95459570/9ce7a30c-a825-42df-a013-0e10a5d69981">
-
-### App Preview :
-
-<table width="100%"> 
-<tr>
-<td width="50%">      
-&nbsp; 
-<br>
-<p align="center">
-  Feed Home
-</p>
-<img src="https://user-images.githubusercontent.com/72341453/134747262-0a92233d-8010-40f8-84c5-8d94895aac44.PNG">
-</td> 
-<td width="50%">
-<br>
-<p align="center">
-  Room Conversation Preview
-</p>
-<img src="https://user-images.githubusercontent.com/72341453/134747155-3ca5b55f-b064-4741-aeae-abe90bddf41e.PNG">  
-</td>
-</table>
-
-<h1>StudyBuddy</h1>
-</div>
-
-- Resources - [Theme](fronend_theme/)
-- Concepts - [Django Concepts](docs/concepts.md)
-- Extensions - Atom One Dark Theme, Prettier, Auto Rename Tag
-
-### Cloning the repository
-
---> Clone the repository using the command below :
-```bash
-git clone https://github.com/dev-mdirfan/StudyBuddy_chat_application.git
+# DevStudy - A chat room for developers
 
-```
+## Description
 
---> Move into the directory where we have the project files : 
-```bash
-cd StudyBud
+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.
 
-```
+## Features
 
---> Create Virtual Environment :
-```shell
-# Let's install virtualenv first
-pip install virtualenv
+- [x] User can sign up and sign in with email and password
+- [x] User can sign in with Google account
+- [x] User can create a new room
+- [x] User can join a room 
+- [x] User can send messages in a room
+- [x] User can see the list of rooms (home feed)
+- [x] User can see the list of members in a room (all participants)
 
-# Then we create our virtual environment
-virtualenv env
-```
+## Technologies
 
---> Activate Env :
-```shell
-env\Scripts\activate
-```
+- Django
+- Django REST Framework
+- HTML
+- CSS
+- JavaScript
 
---> To do deactivate Env :
-```shell
-env\Scripts\deactivate
-```
+## Installation
 
---> Install the requirements :
-```bash
-pip install -r requirements.txt
+1. Clone the project to your local directory
 
+```bash
+git clone 
 ```
 
-**OR:**
-
---> Install Django :
-```shell
-pip install django
-```
+2. Create a virtual environment
 
---> Create Project :
-```shell
-django-admin startproject studybud .
-```
-- Most Useful Commands:
-  - makemigrations
-  - migrate
-  - runserver
-  - startapp
-  - startproject
-
---> Run Server :
-```shell
-python manage.py runserver
+```bash
+python -m venv venv
 ```
 
-> ⚠ Then, the development server will be started at http://127.0.0.1:8000/
+3. Activate the virtual environment
 
---> Create App :
-```shell
-python manage.py startapp base
-```
-
---> Before creating model run migrate :
-```shell
-python mana.py migrate
+```bash
+.\venv\Scripts\activate
 ```
 
+4. Install the dependencies
 
---> Create Model then Make Migration :
-```shell
-python manage.py makemigrations
-# then
-python manage.py migrate
-```
-
---> Create Admin Dashboard Account :
-```shell
-python manage.py createsuperuser
+```bash
+pip install -r requirements.txt
 ```
 
---> Register Your Model to view in the admin panel :
-```shell
-from .models import Room
-# Register your models here.
+5. Run the server
 
-admin.site.register(Room)
+```bash
+python manage.py runserver
 ```
 
+## License
 
-
-#### Resources
-
-- Github Dennis Ivy [StudyBud](https://github.com/divanov11/StudyBud)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+[MIT](https://choosealicense.com/licenses/mit/)
+```