Merge pull request #9 from ProdByGodfather/main

Main

README-FA.md

@@ -28,6 +28,16 @@
 جنگو چنلز در قالب یک برنامه پیام‌رسان طراحی شده است که کلاینت آن جاوا اسکریپت است و بک‌اند آن یک اتصال مبتنی بر وب سوکت با جنگو ایجاد کرده است.
 با این حال بیشتر عملیات نمایش بر سمت کلاینت میباشد و بک اند تنها طبق نیاز json های خود را ارسال میکند.
 
+<center><img src="static/img/dashboard.png" width="100%"></center>
+
+
+علاوه بر قسمت سوپر چت، بخش داشبورد برای کاربران در نظر گرفته شده است که بخش ها و تنظیمات حساب کاربری کاربر را قابل دسترسی میکند. اصولا نمایش تعداد پیغام های کاربر، تعداد چت روم هایی که کاربر در آن حضور دارد به همراه بخش حذف و نمایش چت رومَ، آخرین ورود به حساب و تاریخ ثبت نام را به کاربر نمایش میدهد.
+بخش های دیگر این داشبورد شامل بخش های زیر میباشد:
+1. تغییر رمز عبور.
+2. تنظیمات حساب کاربری و ویرایش نمایه کاربر.
+3. بخش خروج از حساب کاربری.
+
+در واقع بخش اصلی، داشبورد کاربر میباشد که دسترسی به آن فقط با ورود به حساب کاربری امکان پذیر میباشد.
 ## کارایی 
 
 > [!NOTE]

README.md

@@ -21,7 +21,15 @@ All messages are received in the form of json through the client, and the main p
 
 `django channels` is designed in the form of a messenger application whose client is javascript and its back-end has created a websocket-based connection with django.
 
+<center><img src="static/img/dashboard.png" width="100%"></center>
 
+In addition to the Super Chat section, the dashboard section is intended for users, which makes the sections and settings of the user's account accessible. Basically, it shows the number of user messages, the number of chat rooms in which the user is present, along with the deletion and display section of the chat room, the last login to the account and the date of registration.
+Other sections of this dashboard include the following sections:
+1. Changing the password.
+2. User account settings and user profile editing.
+3. Logging out of the user account.
+
+In fact, the main part is the user dashboard, which can be accessed only by logging into the user account.
 
 
 ## Performance

chat/models.py

@@ -6,6 +6,11 @@
 User = get_user_model()
 
 # Create Model Chat
+'''
+    chat models have a room name for get message from were room
+    members can only be viewed once
+    create time for show to user when message is send
+'''
 class Chat(models.Model):
     roomname = models.CharField(max_length=75,blank=True)
     members = models.ManyToManyField(User, null=True,blank=True)
@@ -18,6 +23,12 @@ def __str__(self):
 
 
 # Create Model Message
+'''
+    every message have one chat.
+    every message have one author.
+    every message have content ( this content maybe base64 image or text )
+    every message have an image ( this image save from author image )
+'''
 class Message(models.Model):
     author = models.ForeignKey(User, on_delete=models.CASCADE)
     content = models.TextField()

chat/urls.py

@@ -1,9 +1,11 @@
 from django.urls import path
 from . import views
-
+from users.views import panel
 
 urlpatterns = [
-    path("", views.index, name="index"),
+    # this func has returned another view. new its expired
+    # path("", views.index, name="index"),
+    path("", panel, name="index"),
     path("<str:room_name>/", views.room, name="room"),
     path("<str:room_name>/delete", views.del_room, name="del_room"),
 

chat/views.py

@@ -7,21 +7,36 @@
 
 from chat import models
 
-@login_required()
-def index(request):
-    # get user
-    user = request.user
-    # get user chatrooms
-    chat_rooms = models.Chat.objects.filter(members = user)
 
-    context = {
-        'chat_rooms':chat_rooms,
-    }
+'''
+    login required
+    
+    this function send user to index chat page
+    this page shows to user chat rooms and a input for create chat rooms
+    
+    basicly this page expired
+'''
+# @login_required()
+# def index(request):
+#     # get user
+#     user = request.user
+#     # get user chatrooms
+#     chat_rooms = models.Chat.objects.filter(members = user)
+#
+#     context = {
+#         'chat_rooms':chat_rooms,
+#     }
+#
+#                   NOTE : index.html deleted
+#     return render(request, "chat/index.html",context)
 
 
-    return render(request, "chat/index.html",context)
-
 
+'''
+    index chat room page
+    
+    we send room-name chat-model members-list and usernumbers
+'''
 @login_required()
 def room(request, room_name):
     chat_model = models.Chat.objects.filter(roomname=room_name)
@@ -43,6 +58,13 @@ def room(request, room_name):
     }
     return render(request, "chat/room.html", context)
 
+
+
+'''
+    this is new function
+    users can delete chat room for her selves
+    just chat room never show on user panel
+'''
 def del_room(request, room_name):
     user = request.user
     cat = models.Chat.objects.get(roomname=room_name)

django_channels/settings.py

@@ -149,10 +149,17 @@
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
 
 
+# Login page configs
 LOGIN_URL = reverse_lazy('login')
-
+# If login successfully user redirect to panel
+LOGIN_REDIRECT_URL = reverse_lazy("panel")
 AUTH_USER_MODEL = "users.User"
 
 
+'''
+    media settings for work with images
+    we just use this settings for user images
+'''
+
 MEDIA_URL = '/media/'
 MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

django_channels/urls.py

@@ -22,8 +22,10 @@
 
 
 urlpatterns = [
+    # include chat ( chat room, index chat room page )
     path("chat/", include("chat.urls")),
     path('admin/', admin.site.urls),
+    # include users ( user panel, login page, register page )
     path('',include("users.urls"))
 ]
 

templates/chat/base.html

@@ -13,8 +13,6 @@
   <div id="app" class="app">
     <section id="main-right" class="main-right">
 
-        <!-- Content -->
-
         {% block content %}{% endblock %}
 
     </section>

templates/chat/login.html

@@ -7,23 +7,19 @@
 
 {% block content %}
 <div id="header-right" class="header-right">
-        <!-- profile pict -->
         <div id="header-img" class="profile header-img">
           <img src="{% static 'images/Sample_User_Icon.png' %}" alt="">
         </div>
 
-        <!-- name -->
         <h4 class="name friend-name">
             {% if user.is_authenticated %}
         	{{ just_username }}
             {% else %}
             <span style="color: red">Login Form</span>
             {% endif %}
         </h4>
-
-        <!-- some btn -->
         <div class="some-btn">
-          <span class="glyphicon glyphicon-user"></span>
+            <a href="{% url 'panel' %}" class="btn btn-danger"><span class="glyphicon glyphicon-home"></span></a>
         </div>
       </div>