Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exploring-solver/shravan
https://github.com/exploring-solver/shravan
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/exploring-solver/shravan
- Owner: exploring-solver
- Created: 2024-11-09T07:00:23.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-09T08:58:19.000Z (about 2 months ago)
- Last Synced: 2024-11-09T09:32:23.512Z (about 2 months ago)
- Language: JavaScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shravan AI - The Voice-Driven Automation Assistant ๐
Welcome to **Shravan AI** โ the ultimate voice-activated automation platform for seamless multi-tasking across IoT devices, operating systems, web interactions, messaging, and data retrieval. Designed to simplify complex workflows, Shravan AI acts as a โGOATโ (Greatest of All Time) digital assistant, combining cutting-edge AI and NLP to make daily tasks faster, hands-free, and more accessible to everyone.
---
## ๐ง What is Shravan AI?
Shravan AI is an intelligent assistant powered by NLP and AI to streamline automation through natural voice commands. Inspired by Jarvis and other advanced assistants, Shravan AI enables users to control devices, access information, manage routines, and much more without manual intervention. Built for inclusivity, Shravan AI is especially helpful for individuals with disabilities and non-technical users who can benefit from a powerful yet accessible digital helper.
---
## ๐ Key Features
### 1. **Unified User Dashboard**
- Manage devices, customize tasks, create scripts, and organize file paths.
- Simplified GUI for easy task management and user control.### 2. **IoT Device Integration**
- Centralize control of your IoT devices with Shravan AI's flexible API, connecting all devices seamlessly.
- Supports DIY IoT projects, offering users a fully customizable API interface.### 3. **Voice-Controlled Routines & Commands**
- Execute OS-level commands, device control, and custom scripts using voice input.
- Built-in support for complex, multi-step tasks, designed for smooth, natural interactions.### 4. **NLP-Powered Command Interpretation**
- Integrates multiple NLP models, including Ollama and open-source LLMs, to accurately understand voice commands.
- Ensures nuanced interpretation of commands for diverse accents and variations in speech.### 5. **Custom Script Creation**
- Supports custom automation scripts and routines, letting users tailor Shravan AI to their specific needs.
- Scripts are managed and stored securely, making complex workflows easily repeatable.### 6. **API Documentation and Developer Tools**
- Comprehensive API access for developers, enabling advanced customization and integration.
- Professional tools designed to support both personal and enterprise-level applications.---
## ๐ฒ Shravan AI Mobile App
**Shravan AIโs mobile app** lets you take command on the go. Features include:
- Voice-controlled shortcuts for IoT devices.
- Routine activation with a single touch.
- Real-time notifications for task status.
- Multi-user control and device tracking.
- Offline mode for local IoT control.---
## ๐ฏ Target Audience
Shravan AI is built for:
- **Tech Enthusiasts & DIYers** looking to control their IoT setups effortlessly.
- **Developers** needing API-based automation.
- **Small-Medium Businesses (SMBs)** seeking cost-effective automation solutions.
- **Enterprises** requiring scalable voice-driven automation.
- **Non-Technical Users** who need accessible, hands-free digital assistance.---
## ๐ ๏ธ Tech Stack
Shravan AI is built with a robust tech stack, including:
- **Frontend:** VueJS, ReactJS, React Native, Expo
- **Backend:** NodeJS, ExpressJS, MongoDB, WebSockets
- **AI/NLP Models:** Ollama, open-source LLMs, Gemini API
- **Python Automation:** Selenium, OS libraries for device control, voice command handling
- **Communication:** Secure socket connections for remote task execution
- **Mobile:** Offline mode for local IoT control---
## ๐ผ Business Model
Shravan AIโs business model includes:
- **Subscription-Based SaaS** with tiered access.
- **Freemium Model** with premium upgrades.
- **Enterprise Licensing** for large-scale deployments.
- **Paid API Access** for developers.
- **Professional Services** for custom setup and integrations.---
## ๐ฎ Future Scope
Shravan AI is constantly evolving. Planned features include:
- **Multi-Lingual Support** using advanced models like NVIDIA NemoTron.
- **Full Offline Capability** with a local-only setup powered by Ollama, eliminating dependency on cloud services.
- **AI-Driven Personalization** for user-specific task management and automation experiences.
- **Wearable Device Integration** for hands-free control using wearable IoT devices, enhancing accessibility.---
## ๐ Getting Started
1. **Clone the Repository:**
```bash
git clone https://github.com/exploring-solver/shravan-ai.git
```2. **Backend Setup:**
Navigate to the server directory, install dependencies, and run the server.
```bash
cd server
npm install
npm run dev
```3. **Frontend Setup (Web App):**
Navigate to the `web_user` directory, install dependencies, and start the frontend.
```bash
cd web_user
npm install
npm run dev
```4. **Python Client Setup (Shravan):**
In the `os_interaction` directory, install the Python package and login:
```bash
pip install -e .
shravan login
shravan start
```5. **Mobile App Setup:**
Open the project in Expo, install dependencies, and run on your device.---
## ๐ License
This project is licensed under the MIT License.
**Note:** All code is for personal and non-commercial use only. For any commercial use, explicit permission from the owner ([@exploring-solver](https://github.com/exploring-solver)) is required.---
## ๐๏ธ Contact and Contribution
Contributions to Shravan AI are welcome! Feel free to fork the project and submit pull requests. For questions, suggestions, or support, please open an issue or reach out via the community forums.
**Shravan AI** brings the power of voice to the world of automation. With accessibility, efficiency, and personalization at its core, itโs here to redefine how users interact with technology in their daily lives.
---