🚀 ScrumKit - Open Source Scrum Toolkit

Open source tools for better sprints

Live Demo • Documentation • Report Bug • Request Feature

🎯 Overview

ScrumKit is a modern, self-hostable toolkit for agile development teams. It provides all essential scrum ceremony tools in one unified platform with real-time collaboration, beautiful UX, and deep developer tool integrations.

✨ Key Features

• 🔄 Sprint Retrospectives - Real-time collaborative boards with 10+ built-in templates
• 🎲 Planning Poker - Estimate stories together with customizable sequences
• 📊 Daily Standups - Track progress and blockers efficiently
• 💚 Team Health Checks - Monitor and improve team dynamics
• 🔒 Privacy-First - Self-host your data or use our cloud version
• ⚡ Real-time Sync - Live collaboration without refresh
• 📱 Responsive Design - Works on desktop, tablet, and mobile
• 🔗 Integrations - Connect with Slack, GitHub, Jira, and more

🚀 Quick Start

Prerequisites

• Node.js 18+
• PostgreSQL 14+
• npm or yarn

Installation

# Clone the repository
git clone https://github.com/TheEagleByte/scrumkit.git
cd scrumkit

# Install dependencies
npm install

# Setup environment variables
cp .env.example .env.local
# Edit .env.local with your database and auth credentials

# Run database migrations
npm run db:push
npm run db:seed # Optional: Add sample data

# Start development server
npm run dev

# Open http://localhost:3000

🛠️ Tech Stack

• Framework: Next.js 15 with App Router
• UI Components: Radix UI + Tailwind CSS
• Database: PostgreSQL with Supabase
• Real-time: Supabase Realtime (Postgres Changes, Presence, Broadcast)
• State Management: TanStack Query + React Hooks
• Authentication: Supabase Auth with anonymous user support
• Type Safety: TypeScript with strict mode

🔄 Real-time Architecture

ScrumKit provides a comprehensive real-time collaboration system built on Supabase Realtime:

Core Real-time Features

• 📡 Postgres Changes Subscriptions

  • Automatic synchronization of retrospective items across all clients
  • Real-time vote tracking and updates
  • Live retrospective status changes

• 👥 Presence Tracking

  • See who's currently viewing the board
  • Color-coded user identification
  • Active/away status detection
  • User count display

• 🖱️ Live Cursor Tracking

  • Real-time cursor position sharing
  • Smooth animations with throttled updates
  • User name labels on cursors
  • Container-relative positioning

• 🔌 Connection Management

  • Visual connection status indicator
  • Automatic reconnection with exponential backoff
  • Manual reconnection option
  • Network quality monitoring

Technical Implementation

The real-time system is implemented through custom React hooks:

• useRetrospectiveRealtime() - Manages Postgres change subscriptions
• usePresence() - Handles user presence state
• useCursorTracking() - Tracks and broadcasts cursor positions
• useConnectionStatus() - Monitors connection health
• useBroadcast() - Generic message broadcasting

All real-time features work seamlessly for both authenticated and anonymous users.

📦 Features

🔄 ScrumKit Retro

Create and run sprint retrospectives with your team:

• Anonymous & Authenticated modes - Choose your privacy level
• 10+ Templates - Mad/Sad/Glad, Start/Stop/Continue, 4Ls, and more
• Real-time collaboration - See changes as they happen
• Voting system - Prioritize discussion topics
• Action items - Track follow-ups from retrospectives
• Export options - Markdown, PDF, or integrate with your tools

🎲 ScrumKit Poker

Estimate stories as a team with planning poker:

• Multiple sequences - Fibonacci, T-shirt sizes, custom values
• Story import - Pull from GitHub, Jira, or Linear
• Synchronized reveal - Show all votes at once
• Velocity tracking - Monitor team estimation patterns
• Discussion timer - Keep estimation sessions focused

📊 ScrumKit Daily

Run efficient daily standups:

• Yesterday/Today/Blockers format
• Parking lot for off-topic items
• Round-robin timer - Equal speaking time
• Async updates - Perfect for distributed teams
• Blocker escalation - Notify relevant stakeholders

💚 ScrumKit Health

Monitor team health and morale:

• Spotify health check model - Industry-standard metrics
• Custom metrics - Define what matters to your team
• Trend tracking - See improvements over time
• Anonymous feedback - Honest insights
• Heat map visualization - Spot issues quickly

🔌 Integrations

Available Now

• Slack - Post summaries, create action items
• GitHub - Import/export issues, link PRs

Coming Soon

• Jira - Full sprint synchronization
• Linear - Bi-directional issue sync
• Google Calendar - Schedule ceremonies
• Microsoft Teams - Native integration
• GitLab - Issue management

🗺️ Roadmap

Phase 1: MVP ✅

• Project initialization
• Core retrospective board
• Real-time collaboration (Postgres changes, Presence, Cursor tracking)
• Connection status management
• Anonymous user support
• Basic planning poker
• Authentication system

Phase 2: Enhanced Features

• Team management
• Slack integration
• Daily standup board
• Analytics dashboard

Phase 3: Scale & Polish

• Mobile apps
• Enterprise features
• Advanced analytics
• AI-powered insights

View our detailed roadmap for more information.

🤝 Contributing

We love contributions! Please see our Contributing Guide for details.

Development Setup

# Run tests
npm run test

# Run linting
npm run lint

# Format code
npm run format

# Type checking
npm run type-check

How to Contribute

1. Fork the repository
2. Create your 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

ScrumKit is open source software licensed as MIT.

💬 Community & Support

• GitHub Discussions - Ask questions and share ideas
• Discord Server - Real-time chat with the community
• Bug Reports - Report issues you find
• Feature Requests - Suggest new features

🙏 Acknowledgments

• Built with amazing open source projects
• Inspired by agile teams worldwide
• Special thanks to all contributors

📊 Stats

---

Made with ❤️ by the ScrumKit Team

Website