└── README.md /README.md: -------------------------------------------------------------------------------- 1 | 2 | ![DevFlow Banner](https://files.catbox.moe/8y56pm.png) 3 | # **DevFlow: Software Development Assistant** 4 | BECAUSE THE PROJECT RIGHTS BELONG TO TIETRONIX, THE CODEBASE IS PRIVATE. IF YOU WISH TO REVIEW IT, PLEASE SET UP A VIRTUAL MEETING. 5 | 6 | 7 | [Connect with me](https://www.linkedin.com/in/umarocks) 8 | 9 | https://github.com/user-attachments/assets/01f91328-6bc9-4ccc-a7e6-4f6155de1086 10 | 11 | 12 | 13 | 14 | **DevFlow is an AI-powered software engineering assistant that streamlines the entire development lifecycle — from generating SRS and UML diagrams to producing unit tests and validating code — all within a secure, integrated environment. It features a built-in code IDE and a browser-based Linux terminal running in isolated virtual machines, letting developers write, test, and debug code without ever leaving the platform. By combining Retrieval-Augmented Generation and local LLMs, DevFlow reduces context switching, boosts productivity, and ensures complete data privacy.** 15 | 16 | 17 | ## Features 18 | 19 | ### 📄 SRS Document Generation 20 | 21 | DevFlow introduces a powerful document generation assistant that enables seamless creation of **Software Requirements Specification (SRS)** documents using natural language prompts and context-aware understanding. 22 | 23 | #### 🚀 Current Capabilities 24 | Use the `@DOCGEN` command in the chatbot to generate a complete SRS document with just a single line of input. 25 | For example: 26 | 27 | ![DOCGEN](https://files.catbox.moe/eyxp6m.png) 28 | 29 | 30 | 31 | - ✅ Automatically organizes standard SRS sections: 32 | *Introduction, Functional Requirements, System Architecture, Non-Functional Requirements*, etc. 33 | - ✅ Smart breakdown of modules and features based on the given prompt. 34 | - ✅ Edits and additions can be made section-wise within the app. 35 | - ✅ Download the generated document as **PDF**, **DOCX**, or **Markdown**. 36 | 37 | #### 🔭 Long-Term Vision 38 | The goal is to evolve DevFlow’s document generation system into a **fully autonomous development documentation assistant**. 39 | 40 | > 💡 Imagine this: 41 | > During a client meeting, an in-app **Meeting Transcriber** listens to the discussion, captures core technical requirements, goals, constraints, and user flows — then auto-generates a polished SRS draft without the team writing a single line. 42 | 43 | This intelligent pipeline will eventually support other technical documents too: 44 | - ✅ Project Reports 45 | - ✅ Design Documents 46 | - ✅ API Docs 47 | - ✅ Test Plans 48 | 49 | #### 🎯 Why It Matters 50 | - 🕒 Saves hours of writing and formatting 51 | - 📄 Maintains consistent documentation quality 52 | - 🤝 Bridges communication between clients and devs 53 | - 📂 Reduces back-and-forth in Agile cycles 54 | 55 | --- 56 | 57 | 58 | 59 | ### UML Generation 60 | - **UML Generation** is simplified using custom commands like `@SEQUENCE` `@ACTIVITY` `@CLASS` etc based on your SRS document or chat inputs. 61 | - The generated UML code and diagrams are displayed and can be downloaded for further use. 62 | 63 | ![UML Generation](https://files.catbox.moe/yolt0e.png) 64 | ![Example Of Generated Sequence Diagram](https://files.catbox.moe/df7n36.svg) 65 | ### Unit Test Generation 66 | DevFlow supports automated unit test generation and testing directly in the app. The section consists of four components: 67 | 1. **Chatbot Area**: Use the `@gitclone` command to clone repositories and virtually mount them to your workspace. `@TESTGENERATE` to generate test case for the file that is opened in the in app code ide, or `@TESTALL` to generate test files for each file in the virtual file system. 68 | 2. **File System**: A client-side file system that can be mounted to a individualized **secure Linux VM**, allowing you to work directly on your codebase. These VM can be shared between multiple people, teams and groups if needed. 69 | 3. **Terminal**: Interact with your VM via a custom terminal section, much like AWS EC2 webterminal but optimized for developer needs. 70 | 4. **IDE**: Code, test, and run your software directly in the app without switching tabs or environments. 71 | 72 | ![Unit Test](https://files.catbox.moe/w23iog.png) 73 | 74 | ### Documentation Management (RAG) 75 | - **Document RAG (Retreival-Augmented-Generation)**: Store your **SRS** and other code documentation for easy retrieval and management.You can ask questions such as asking for a specific method in the code base or asking what that specific method is used for across the codebase. 76 | - **Assist Developers**: Search and retrieve relevant coding documentation to increase productivity and ensure alignment with coding standards. Developers can directly access the pdf opened in the tab and can navigate the pdf if needed for further context. 77 | 78 | 79 | 80 | ### Verify & Validate 81 | - **Code Validation**: Automatically run unit tests, generate reports, and score your software based on predefined coding guidelines. 82 | - **Score & Metrics**: The validation section will provide a score for your software quality, highlighting potential improvements and ensuring high code standards. 83 | 84 | ![Verify & Validate](https://files.catbox.moe/xxxd04.png) 85 | 86 | ## Technologies Used 87 | - **Frontend**: React, Tailwind CSS 88 | - **Backend**: FastAPI 89 | - **Linux Environment**: Alpine Linux VM for secure, isolated coding and testing environments 90 | - **Chatbot Integration**: Custom commands like `@SEQUENCE`, `@TESTGENERATE`, and `@gitclone` for seamless interaction. 91 | 92 | ## Installation 93 | To run **DevFlow** locally, follow these steps: 94 | 95 | 1. Clone the repository: 96 | ```bash 97 | git clone https://github.com/umarocks/DevFlow.git 98 | ``` 99 | 100 | 2. Navigate into the project directory: 101 | ```bash 102 | cd DevFlow 103 | ``` 104 | 105 | 3. Docker Compose: 106 | ```bash 107 | docker compose up --build 108 | ``` 109 | ## License 110 | This project is licensed under the **Proprietary License**. All rights are reserved. 111 | 112 | All Rights Reserved 113 | 114 | Copyright (c) [2025] UMAR ABDUL AZIZ 115 | 116 | This software is proprietary and confidential. All rights are reserved by the author. No part of this software may be copied, used, modified, distributed, or otherwise utilized in any way for any purpose without the express written permission of the copyright holder. 117 | 118 | You are not authorized to use, copy, modify, or distribute this software under any circumstances. 119 | 120 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT ANY WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHOR OR COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 121 | 122 | ## Contact 123 | For any inquiries, you can reach out via email: 124 | 125 | - **Email**: [umar.a.aziz2001@gmail.com](mailto:umar.a.aziz2001@gmail.com) 126 | 127 | --------------------------------------------------------------------------------