Skip to content

RoushanKhalid/SRS-Studio

Repository files navigation

Collaborative Sprint SRS Studio

Turn one requirement into a clean SRS using a multi-agent pipeline.

Demo Video

Local demo recording:

Screen.Recording.2026-04-23.163110.mp4

Mode toggle behavior:

  • docs/Screen Recording 2026-04-23 163110.mp4

What This Project Does

  • Accepts a requirement from UI or API
  • Runs all workflow nodes:
    • planner -> architect -> developer -> qa -> reviewer -> discussion -> erd -> timeline -> srs
  • Saves run history and step snapshots
  • Exports SRS as markdown
  • Shows ERD diagram in the UI (Mermaid rendered)

Fast Mode Toggle (UI)

  • ON: same full node chain, simpler output per node, fastest response
  • OFF: same full node chain, slightly richer output, still fast

You can toggle this from the web UI before starting a run.

Quick Start

1) Install

python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt
copy .env.example .env

2) Configure .env

Minimum required:

  • POSTGRES_DSN
  • one API key: GOOGLE_API_KEY or GROQ_API_KEY

3) Run

python run.py

Open:

  • http://127.0.0.1:8000/ (UI)
  • http://127.0.0.1:8000/health (health check)

Simple API Example

curl -X POST http://127.0.0.1:8000/api/v1/build ^
  -H "Content-Type: application/json" ^
  -d "{\"user_requirement\":\"Build a task API with auth and tests.\",\"fast_mode\":true}"

Useful endpoints:

  • POST /api/v1/build
  • GET /api/v1/runs/{run_id}
  • GET /api/v1/runs/{run_id}/progress
  • GET /api/v1/runs/{run_id}/srs
  • GET /api/v1/runs/{run_id}/srs.md

Main Configs

  • FAST_MODE=true (default complexity mode)
  • GOOGLE_API_KEY, GOOGLE_MODEL
  • GROQ_API_KEY, GROQ_MODEL
  • FALLBACK_TO_OLLAMA_ON_QUOTA_EXCEEDED
  • STEP_TIMEOUT_SECONDS, STEP_MAX_RETRIES

Project Structure

app/
  agents/    workflow logic
  api/       REST endpoints
  core/      config/security/export
  memory/    DB storage and retrieval
  schemas/   pydantic contracts
  ui/        web UI
docs/        setup, runbook, plans
tests/       tests
run.py       one-click launcher

About

A lightweight multi-agent SRS generator that turns a single software requirement into a complete markdown SRS through a full agent pipeline (planner → architect → developer → qa → reviewer → discussion → erd → timeline → srs). It includes Fast Mode toggle, API + UI, ERD diagram rendering, run tracking, and provider fallbacks.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors