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

 
 
 

Contributors