From 5a0e0f27b500a66c43315c2ef29d3d5f37496aa0 Mon Sep 17 00:00:00 2001 From: Nitya Gosain Date: Fri, 19 Dec 2025 11:26:14 +0530 Subject: [PATCH] Update README.md --- README.md | 259 ++++++++++++++++++++++++------------------------------ 1 file changed, 113 insertions(+), 146 deletions(-) diff --git a/README.md b/README.md index d9d3810b9..6ea31b024 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

Hey <𝚌𝚘𝚍𝚎𝚛𝚜/>! 👋

+

Hey <𝚌𝚘𝚍𝚎𝚛𝚜/>! 👋

[![Typing SVG](https://readme-typing-svg.demolab.com?font=Monoton&size=85&pause=12&speed=12&color=00FF00¢er=true&vCenter=true&width=2000&height=200&lines=Hello+World!;Meet+Jarvis+-+Your+AI+Assistant!;Enhance+Productivity+with+AI!;Automate.+Assist.+Achieve!;Voice+Commands+at+Your+Fingertips!;AI+Driven+Efficiency!;Build+Smarter,+Work+Faster!;Innovate+with+Machine+Learning!)](https://git.io/typing-svg) @@ -9,7 +9,10 @@ -

+ +

+ +

@@ -17,179 +20,143 @@ -
+

+ +

-

+

+ + + + +

+ +

+ + + +

+ - ![Automation](https://img.shields.io/badge/Automation-ff5733?style=flat-square) - ![AI Models](https://img.shields.io/badge/AI-Models-007bff?style=flat-square) - ![Python Programs](https://img.shields.io/badge/Python-Programs-ffc300?style=flat-square) - ![User Services](https://img.shields.io/badge/User-Services-6a1b9a?style=flat-square) - ![Admin Tools](https://img.shields.io/badge/Admin-Tools-28a745?style=flat-square) - ![Authentication](https://img.shields.io/badge/Authentication-34495e?style=flat-square) -

+--- -

+![intro](./assets/intro.gif) - ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54) - ![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white) - ![Streamlit](https://img.shields.io/badge/Streamlit-%23FE4B4B.svg?style=for-the-badge&logo=streamlit&logoColor=white) -

+## 🚀 About Jarvis -

+**Jarvis** is an AI-powered virtual assistant designed to simplify daily tasks using **voice and text-based commands**. +It integrates **automation, authentication, admin tools, and AI/ML models** into a single, extensible system. - ![ML](https://img.shields.io/badge/ML-%23FF7F50.svg?style=for-the-badge) - ![DL](https://img.shields.io/badge/DL-%23FF6347.svg?style=for-the-badge) - ![NLP](https://img.shields.io/badge/NLP-%23706FD3.svg?style=for-the-badge) - ![GAN](https://img.shields.io/badge/GAN-%23FF69B4.svg?style=for-the-badge) - ![LLM](https://img.shields.io/badge/LLM-%238E44AD.svg?style=for-the-badge) - ![AI](https://img.shields.io/badge/AI-%234A90E2.svg?style=for-the-badge) -

+Jarvis is built with **Python** and **Streamlit**, making it easy to prototype, extend, and contribute to — especially for open-source beginners and program participants. - +--- ---- +## ✨ Core Features -![img](./assets/intro.gif) +- 🎙️ Voice & text command execution +- ⚙️ Automation of repetitive tasks +- 👥 Role-based access (User / Admin) +- 🔐 Google Authentication via Streamlit +- 🧠 AI/ML model integrations +- 🛠️ Admin utilities & user services -#### :zap: About Jarvis 🌟 +--- -**Jarvis** is a powerful virtual AI assistant designed to simplify your daily tasks through voice command integration. With features like automation, device management, and personalized interactions, Jarvis transforms the way you engage with technology. Built using Python and enhanced with AI models, it serves as an efficient tool for both personal and administrative needs, making everyday processes seamless and more productive. +> Each module is **independent but connected**, making Jarvis highly modular and contributor-friendly. -#### :zap: Core Features 🔑 +--- -- Control devices and execute tasks using natural language commands. -- Streamline repetitive tasks to save time and effort. -- Supports multiple user roles (User, Admin) for tailored access. -- Utilizes Streamlit built-in auth system for google authentication. +## 🏁 Getting Started (For First-Time Users) + +### 🔧 Prerequisites + +- Python **3.9+** +- Git +- Basic understanding of Python & Streamlit + +### 📦 Setup Instructions +# Clone the repository +``` +git clone https://github.com/Code-A2Z/jarvis.git +cd jarvis +``` + +# Create virtual environment +``` +python -m venv venv +source venv/bin/activate # Windows: venv\Scripts\activate +``` + +# Install dependencies +``` +pip install -r requirements.txt +``` + +# Environment Setup +- Copy the example secrets file: +``` +cp secrets.example.toml secrets.toml +``` +- Add required keys (Google Auth, API keys, etc.) +▶️ Run Jarvis +``` +streamlit run main.py +``` -
-

:zap: Important Points to remember while submitting your work 📍

 +--- -> We want your work to be readable by others; therefore, we encourage you to note the following: +## 🧪 Example Use Cases +- “Open YouTube” +- “Run my automation script” +- “Show admin dashboard” +- “Authenticate user via Google” +- “Trigger AI model inference” +Both **voice and text-based commands** are supported. -1. Use `PascalCase` for directory/folder names (e.g., `BrainTumorModel`, `DiabetesModel`). -2. Use `camelCase` for file names (e.g., `movieRecommendationModel`, `latestNews`, `ticTakToe`). -3. Name the main function exactly the same as the file name. -4. Limit commits to 3-4 unless given permission by project Admins or Mentors. -5. Keep commit messages clear and relevant; avoid unnecessary details. -6. **Never commit deployed model files to the repository; upload them to Google Drive, provide a downloadable link in the PR template, and update the `secrets.example.toml` file accordingly.** +--- +## 🤝 Contribution Guidelines +We ❤️ contributors! Please read carefully before submitting PRs. + +

📌 Coding Standards

 +1. Use PascalCase for folders +2. Use camelCase for files +3. Main function name must match file name +4. Keep commits limited (3–4 max unless approved) +5. Never commit trained model files +6. Upload models to Google Drive and link in PR +

🧲 Pull Request Review Criteria

 +- Fill PR template completely +- Do not push directly to main +- Original work only +- Add comments for clarity +- Attach working demo video +- Include screenshots for UI changes
-
-

:zap: Pull Requests Review Criteria 🧲

 +--- -1. Fill out the ***PR template*** properly when submitting a pull request. -2. Do not commit directly to the `main` branch, or your PR will be instantly rejected. -3. Ensure all work is original and not copied from other sources. -4. Add comments to your code wherever necessary for clarity. -5. Include a working video and show integration with Jarvis as part of your PR. -6. For frontend updates, share screenshots and work samples before submitting a PR. +## ❄️ Open Source Programs +> Jarvis actively supports and welcomes contributors from: -
+GSSoC • Hacktoberfest • IWOC • SSOC • KWOC • DWOC • IEEE OSW • 24 Pull Requests --- -
+## 🌟 Contributors -### ❄️ Open Source Programs - - - - - - - - - - - - - - - - -
-
- -

SSOC

- 2024 | - 2025 -
- 		-
- -

VSOC

- 2024 -
- 		-
- -

GSSoC

- Ext 2024 -
- 		-
- -

Hacktoberfest

- 2024 -
- 		-
- -

IEEE Open-Source Week

- 2024 -
-
-
- -

KWOC

- 2024 -
- 		-
- -

24 Pull Requests

- 2024 -
- 		-
- -

IWOC

- 2025 -
- 		-
- -

SWOC

- 2025 -
- 		-
- -

DWOC

- 2025 -
-
- -### ✨ Our Valuable Contributors - - - - - -![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) - -# Tip from us 😇 -##### It always takes time to understand and learn. So, don't worry at all. We know you have got this! 💪 -### Show some  ❤️  by  🌟  this repository! + -
+## 💡 Tip from Us +**Learning takes time. +Don’t rush. Don’t compare. +You’ve got this. 💪** + +Show some ❤️ by starring this repository 🌟 - +