Skip to content

nidqija/Software-Requirements-Automate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

alt text

SR Automate 🚀

Human Prompt → Sequence Diagram , Class Diagram , Flowchart

Go Version Vue Version PocketBase

SR Automate is an AI-driven tool designed to bridge the gap between abstract software requirements and technical documentation. By leveraging LLMs, it transforms natural language prompts into structured, renderable diagrams.


📌 Problem Statement

The transition from a business requirement to a technical design is often the most friction-heavy phase of the SDLC:

  • The "Blank Page" Bottleneck: Engineers spend excessive time manually drafting initial diagrams, delaying architectural discussions.
  • Syntax Complexity: Tools like Mermaid.js require learning specific syntax, creating a barrier for non-technical stakeholders.
  • Documentation Drift: Updating visual diagrams is tedious, leading to outdated docs that misalign teams.

🎯 Our Mission

SR Automate acts as a Technical Translator to:

  1. Accelerate Velocity: Generate a 90% complete architectural starting point in seconds.
  2. Democratize Design: Enable Product Managers to generate technical visuals without mastering code.
  3. Ensure Consistency: Keep natural language and technical syntax in perfect sync.

🛠️ Tech Stack

Component Technology
Frontend Vue 3 (Vite), Bootstrap 5.2, Axios
Backend Go (PocketBase Framework)
Database Embedded SQLite (via PocketBase)
LLM Ollama (Gemma3)
Rendering Mermaid.js

🔄 Technical Workflow

  1. Input: User enters a natural language requirement (e.g., "User signs up via Google").
  2. Processing: The Go backend sends the prompt to Ollama with specialized system instructions.
  3. Generation: The LLM returns valid Mermaid.js syntax.
  4. Rendering: The Vue.js frontend reactively renders the syntax into an interactive SVG diagram.

📂 Project Structure

SR_Automate/
├── backend/             # Go (PocketBase) Server
│   ├── main.go          # API Routes & AI Controller
│   └── pb_data/         # Database & Migrations
└── frontend/            # Vue 3 Web App
    ├── src/
    │   ├── factory/     # Mermaid syntax templates
    │   ├── views/       # EditDiagramView.vue, Home.vue
    │   └── api/         # Axios configuration
    └── package.json


📚 Documentation


About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors