Fix/project structure docs 346

README.md

@@ -68,6 +68,57 @@
 - Supports multiple user roles (User, Admin) for tailored access.
 - Utilizes Streamlit built-in auth system for google authentication.
 
+#### 📁 Project Structure
+
+```
+jarvis/
+├── .github/                 # GitHub configurations
+│   ├── ISSUE_TEMPLATE/      # Issue templates for bug reports, feature requests
+│   ├── workflows/           # GitHub Actions CI/CD workflows
+│   └── PULL_REQUEST_TEMPLATE.md  # PR template for contributors
+├── .streamlit/              # Streamlit configuration files
+├── assets/                  # Images, GIFs, and media assets
+├── src/                     # Source code directory
+│   ├── apps/                # Main application modules
+│   │   ├── auth/            # Authentication system
+│   │   ├── public/          # Public pages (home, YouTube playlist)
+│   │   └── pages/           # Application pages organized by category
+│   │       ├── automations/ # Automation tools
+│   │       │   ├── Coding/        # Code-related automations
+│   │       │   ├── Messenger/     # Email and messaging tools
+│   │       │   ├── SocialMediaApps/ # Social media integrations
+│   │       │   └── Websites/      # Website automation tools
+│   │       ├── models/      # AI/ML model implementations
+│   │       │   ├── ImageProcessing/ # Image processing models
+│   │       │   ├── ObjectDetection/ # Object detection models
+│   │       │   ├── Recommendation/  # Recommendation systems
+│   │       │   └── Utility/         # Utility models
+│   │       └── programs/    # Various programs and tools
+│   │           ├── API/           # API integrations
+│   │           ├── Games/         # Interactive games
+│   │           ├── ImageGenerators/ # Image generation tools
+│   │           ├── Simple/        # Simple utility programs
+│   │           └── Study/         # Educational tools
+│   ├── helpers/             # Helper functions and utilities
+│   └── utils/               # Utility functions
+├── Jarvis.py                # Main application entry point
+├── requirements.txt         # Python dependencies
+├── pyproject.toml           # Project configuration
+├── uv.lock                  # Dependency lock file
+├── SETUP.md                 # Setup instructions
+├── Contributing.md          # Contribution guidelines
+├── CODE_OF_CONDUCT.md       # Code of conduct
+└── README.md                # Project documentation
+```
+
+The project follows a modular structure where each feature is implemented as a separate module within the appropriate category. The `src/apps/pages/` directory contains the main functionality organized by type:
+
+- **Automations**: Tools for automating repetitive tasks
+- **Models**: AI/ML implementations for various use cases
+- **Programs**: Interactive applications and utilities
+
+Each module is designed to be self-contained and follows the naming conventions specified in the contribution guidelines.
+
 <details>
 <summary><h4>:zap: Important Points to remember while submitting your work 📍</h4></summary>
 

src/apps/auth/auth.py

@@ -4,7 +4,7 @@
 import pytz
 import streamlit as st
 
-from src.utils.greeting import GreetUser
+from src.utils.greeting import GetRandomWelcomeMessage, GreetUser
 
 
 def unix_to_ist(timestamp):
@@ -22,7 +22,7 @@ def auth():
 
   else:
     st.title(f"🙏 {GreetUser(st.user.given_name)}")
-    st.success("Welcome to Jarvis AI Assistant!", icon="🤝")
+    st.success(GetRandomWelcomeMessage(), icon="🤝")
     st.image(st.user.picture, caption=st.user.name)
     st.write("Email:", st.user.email)
 

src/utils/greeting.py

@@ -1,3 +1,4 @@
+import random
 from datetime import datetime
 
 import pytz
@@ -13,3 +14,20 @@ def GreetUser(name):
   elif 17 <= hour < 21:
     return f"Good Evening, {name}"
   return f"Good Night, {name}"
+
+
+def GetRandomWelcomeMessage():
+  """Returns a random welcome message to make Jarvis feel more dynamic and natural."""
+  welcome_messages = [
+    "I am Jarvis Sir. Please tell me how may I help you.",
+    "Ready to assist you with anything you need!",
+    "At your service! What can I do for you today?",
+    "Hello! I'm here to make your day easier.",
+    "Great to see you! How can I assist you?",
+    "I'm all set to help you out. What's on your mind?",
+    "Standing by to help with whatever you need!",
+    "Your AI assistant is ready. What would you like to do?",
+    "Here to help! Just let me know what you need.",
+    "Ready and waiting to assist you today!",
+  ]
+  return random.choice(welcome_messages)