An open API service indexing awesome lists of open source software.

https://github.com/entanglequanta-labs/entangle-app

Entangle (Prototype) : Automate Mobile workflows with AI . Block apps, hide features, and more using natural language .
https://github.com/entanglequanta-labs/entangle-app

ai andriod automate fastapi ios python react-native typescript

Last synced: 5 months ago
JSON representation

Entangle (Prototype) : Automate Mobile workflows with AI . Block apps, hide features, and more using natural language .

Awesome Lists containing this project

README

          

# Entangle (Automate Your Mobile wokflows)
## Overview
Entangle is a mobile application designed to automate workflows on Mobile devices using Accessibility Services. It integrates an AI chatbot powered by Llama (Groq) to generate and execute user-defined workflows. The project is built with a modular architecture, making it easy for contributors to collaborate on frontend, backend, AI, and Accessibility Services components.

---

## Key Features
- **Workflow Automation**: Automate tasks like blocking downloads in the Play Store, hiding YouTube Shorts, or restricting features in apps like Instagram (Just an examople).
- **Modular Architecture**: Designed for seamless collaboration among teams.

---

## Technology Stack

### Frontend
- **Framework**: React Native with Expo

### Backend
- **Framework**: FastAPI

### AI (LLM)
- **Model**: Llama-70b (Groq)
- **Purpose**: Generate contextual workflows based on user input.

### Android Accessibility Services
- **Purpose**: Automate tasks by interacting with Android system UI.

---

## How to Contribute
We welcome contributions from the community! Whether you're a developer, designer, or tester, there are many ways to get involved.

### Prerequisites
- Node.js and npm installed.
- Python 3.x installed.
- Android Studio for Accessibility Services development.
- Basic understanding of React Native, Flask, and Android development.

---

### Setting Up the Project

1. **Fork the Repository**:
- Click the "Fork" button on the top right of the repository page.

2. **Clone Your Fork**:
```bash
git clone https://github.com/your-username/entangle.git
cd entangle
```

3. **Install Dependencies**:
- **Frontend**:
```bash
cd frontend
npm install
```
- **Backend**:
```bash
cd backend
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```

4. **Run the Project**:
- **Frontend**:
```bash
npm start
```
- **Backend**:
```bash
uvicorn app.main:app --reload
```

---

### Contribution Guidelines

1. **Create a New Branch**:
- Always create a new branch for your work:
```bash
git checkout -b feature/your-feature-name
```

2. **Follow Coding Standards**:
- Use consistent formatting and follow the existing code style.
- Write clear and concise commit messages.

3. **Test Your Changes**:
- Ensure your changes work as expected and do not break existing functionality.
- Write unit tests if applicable.

4. **Submit a Pull Request**:
- Push your changes to your forked repository:
```bash
git push origin feature/your-feature-name
```
- Open a pull request (PR) to the `main` branch of the original repository.
- Provide a detailed description of your changes in the PR.

---

### Areas to Contribute

1. **Frontend**:
- Improve the user interface for workflow creation and monitoring.
- Add new screens or features to enhance user experience.

2. **Backend**:
- Develop new API endpoints for additional workflows.
- Optimize existing workflow logic.

3. **AI Integration**:
- Fine-tune the Llama model for better workflow generation.
- Improve the AI's ability to handle edge cases.

4. **Android Accessibility Services**:
- Add new automation tasks (e.g., blocking ads, hiding UI elements).
- Optimize existing Accessibility Service logic.

5. **Testing**:
- Write unit tests for frontend and backend components.
- Test the application on different Android devices and versions.

---

### Code of Conduct
Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing. We are committed to fostering a welcoming and inclusive community.

---

### Reporting Issues
If you encounter any issues or have suggestions for improvements, please open an issue on the repository. Provide as much detail as possible, including steps to reproduce the issue.

---

### License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

## Contact
For questions or feedback, feel free to reach out to the maintainers or open an issue in the repository.

---

**Thank you for contributing to Entangle!** 🚀