Skip to content

itsnothuy/Scruminizer

Repository files navigation

πŸ€– AI Scrum Master

Intelligent Sprint Management & Team Automation Platform

An AI-powered Scrum Master that automates sprint management, generates intelligent insights, and integrates seamlessly with Jira, Slack, and OpenAI to enhance team productivity.

AI Scrum Master Demo TypeScript React NestJS OpenAI

🎯 Overview

The AI Scrum Master revolutionizes how agile teams manage sprints by combining artificial intelligence with real-time integrations. This MVP demonstrates a complete, functional system that provides intelligent sprint analysis, automated standup summaries, and seamless workflow automation.

✨ Key Features

  • 🧠 AI-Powered Insights: GPT-4 integration for intelligent sprint analysis and recommendations
  • πŸ“Š Real-time Jira Integration: Automatic sprint data synchronization and issue tracking
  • πŸ’¬ Slack Bot Automation: Automated standup reminders and team notifications
  • πŸ“ˆ Interactive Dashboard: Modern React interface with real-time data visualization
  • πŸ”„ Automated Workflows: Streamlined sprint planning and progress tracking
  • πŸ›‘οΈ Production Ready: TypeScript, error handling, and scalable architecture

πŸš€ Live Demo

Quick Start

# Clone the repository
git clone https://github.com/itsnothuy/Scruminizer.git
cd Scruminizer

# Start Backend (Terminal 1)
cd backend
npm install
npm run start:dev

# Start Frontend (Terminal 2)
cd frontend
npm install
npm start

Demo URLs

πŸ—οΈ Architecture

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚   React UI      │────│   NestJS API     │────│  External APIs  β”‚
β”‚                 β”‚    β”‚                  β”‚    β”‚                 β”‚
β”‚ β€’ Dashboard     β”‚    β”‚ β€’ JWT Auth       β”‚    β”‚ β€’ Jira REST     β”‚
β”‚ β€’ Real-time     β”‚    β”‚ β€’ GraphQL/REST   β”‚    β”‚ β€’ OpenAI GPT-4  β”‚
β”‚ β€’ Responsive    β”‚    β”‚ β€’ WebSockets     β”‚    β”‚ β€’ Slack Bot     β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Technology Stack

Frontend

  • βš›οΈ React 18 with TypeScript
  • 🎨 Modern CSS with Gradient Design
  • πŸ“± Responsive Mobile-First UI
  • πŸ”„ Real-time Data Fetching

Backend

  • πŸ—οΈ NestJS Framework
  • πŸ“ TypeScript for Type Safety
  • πŸ”Œ RESTful API Design
  • πŸ” Environment-based Configuration

Integrations

  • 🎯 Jira: Project tracking and sprint management
  • πŸ€– OpenAI: GPT-4 for intelligent analysis
  • πŸ’¬ Slack: Team communication and automation

πŸ“± Screenshots & Features

Main Dashboard

πŸ€– AI Scrum Master
Intelligent Sprint Management & Team Insights

πŸ“Š Daily Standup Summary
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

πŸ“Š SPRINT OVERVIEW:
β€’ Total Issues: 5
β€’ In Progress: 3  
β€’ To Do: 2

πŸš€ IN PROGRESS (3 items):
β€’ SCRUM-101: Implement AI-powered sprint planning dashboard
  πŸ‘€ Assignee: Alice Johnson
  ⚑ Priority: High

API Endpoints

Endpoint Method Description
/ GET Health check and API status
/standup-summary GET AI-generated sprint summary
/demo/jira-issues GET Real-time Jira integration demo

πŸ› οΈ Installation & Setup

Prerequisites

  • Node.js 18+ and npm
  • Jira account and API token
  • OpenAI API key
  • Slack workspace and bot tokens

Environment Configuration

Create backend/.env:

# Jira Integration
JIRA_HOST=https://your-company.atlassian.net
JIRA_USER_EMAIL=your-email@company.com
JIRA_API_TOKEN=your_jira_api_token

# OpenAI Integration  
OPENAI_API_KEY=your_openai_api_key

# Slack Integration
SLACK_BOT_TOKEN=xoxb-your-bot-token
SLACK_SIGNING_SECRET=your_signing_secret
SLACK_APP_TOKEN=xapp-your-app-token

Backend Setup

cd backend
npm install
npm run start:dev

Frontend Setup

cd frontend
npm install
npm start

πŸŽͺ Demo Instructions

1. Terminal Demo

# Health Check
curl http://localhost:3002/
# Response: "πŸ€– AI Scrum Master Backend - Ready to optimize your team's productivity!"

# Get AI Summary
curl http://localhost:3002/standup-summary
# Response: Detailed AI-generated sprint analysis with recommendations

# Test Jira Integration
curl http://localhost:3002/demo/jira-issues
# Response: Real-time sprint data with team assignments

2. Web Interface Demo

  1. Navigate to http://localhost:3000
  2. View the modern dashboard with gradient design
  3. Click "πŸ”„ Refresh Summary" to see real-time updates
  4. Explore the feature cards showcasing integrations

3. Key Demo Points

  • βœ… Real Integrations: Connected to actual Jira, OpenAI, and Slack
  • βœ… AI Intelligence: GPT-4 powered insights and recommendations
  • βœ… Production Architecture: TypeScript, error handling, scalability
  • βœ… Team Impact: Immediate productivity improvements

πŸ”§ Development

Project Structure

ai-scrum-master/
β”œβ”€β”€ backend/                 # NestJS API Server
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ modules/
β”‚   β”‚   β”‚   β”œβ”€β”€ ai/         # OpenAI Integration
β”‚   β”‚   β”‚   β”œβ”€β”€ jira/       # Jira API Integration
β”‚   β”‚   β”‚   └── slack/      # Slack Bot Integration
β”‚   β”‚   β”œβ”€β”€ app.module.ts   # Main Application Module
β”‚   β”‚   └── main.ts         # Application Entry Point
β”‚   β”œβ”€β”€ package.json
β”‚   └── tsconfig.json
β”œβ”€β”€ frontend/               # React UI Application
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ components/     # Reusable Components
β”‚   β”‚   β”œβ”€β”€ App.tsx         # Main Application
β”‚   β”‚   └── App.css         # Styling
β”‚   β”œβ”€β”€ public/
β”‚   └── package.json
β”œβ”€β”€ docs/                   # Documentation
β”œβ”€β”€ DEMO_PRESENTATION.md    # Live Demo Guide
└── demo_script.md         # Comprehensive Demo Script

Development Commands

# Backend Development
cd backend
npm run start:dev          # Start with hot reload
npm run build              # Production build
npm run test               # Run tests

# Frontend Development  
cd frontend
npm start                  # Development server
npm run build              # Production build
npm test                   # Run tests

🎯 Use Cases

For Development Teams

  • πŸ“Š Automated Sprint Tracking: Real-time progress monitoring
  • πŸ€– AI-Powered Insights: Intelligent bottleneck detection
  • ⚑ Workflow Automation: Reduced manual overhead

For Scrum Masters

  • πŸ“ˆ Data-Driven Decisions: Comprehensive sprint analytics
  • πŸ’¬ Team Communication: Automated standup facilitation
  • 🎯 Predictive Planning: AI-assisted sprint forecasting

For Product Managers

  • πŸ“Š Executive Dashboards: High-level progress visibility
  • πŸ” Performance Metrics: Team velocity and quality insights
  • πŸ“‹ Backlog Optimization: AI-recommended prioritization

πŸš€ Deployment

Production Deployment Options

Google Cloud Platform

# Deploy Backend to Cloud Run
gcloud run deploy ai-scrum-master-api --source backend/

# Deploy Frontend to Vercel
vercel --prod frontend/

Docker Deployment

# Build and run with Docker
docker-compose up --build

🀝 Contributing

We welcome contributions! Please see our Contributing Guidelines.

Development Workflow

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸŽ–οΈ Acknowledgments

  • OpenAI for GPT-4 API capabilities
  • Atlassian for Jira integration support
  • Slack for bot platform and APIs
  • NestJS & React communities for excellent frameworks

πŸ“ž Contact & Support


πŸ€– AI Scrum Master - Transforming Agile Teams with Intelligence

⭐ Star this repo | 🍴 Fork it | πŸ“ Report Bug

Made with ❀️ by developers, for developers

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published