A web application that creates shareable, readonly Kanban boards from GitHub issues. The app allows teams to visualize their GitHub issues in a Kanban format and share progress with customers via magic links, providing transparency without requiring authentication.
Development teams often struggle to communicate project progress to clients in an intuitive way. Traditional GitHub issue lists are not visually appealing and don't provide the clear project overview that Kanban boards offer. Clients need a simple, accessible way to see project status without needing GitHub accounts or technical knowledge.
A web application that:
- Connects to GitHub repositories via API
- Syncs issues with specific labels to create Kanban lanes
- Generates shareable magic links for readonly access
- Provides a mobile-responsive Kanban interface using Flux UI
- Allows custom configuration per board via CLI commands
- Development Teams: Who want to share project progress with clients
- Project Managers: Who need to visualize and communicate project status
- Clients/Customers: Who want to see project progress without technical barriers
- Stakeholders: Who need project visibility
- QA Teams: Who want to track issue progress
- Create boards via CLI commands with UUID
- Configure board-level settings via JSON files
- Generate multiple access URLs per board
- Soft delete support for boards
- Add GitHub repositories to boards via CLI (owner/repo format)
- Configure repositories via JSON configuration
- Soft delete support for repositories
- Embedded owner information in configuration
- CLI command to sync GitHub issues per repository
- Filter issues by configured labels
- Map GitHub labels to Kanban lanes per repository
- Handle issue status changes (open/closed)
- Store complete issue data in JSON format
- Automatic lane creation based on GitHub labels per repository
- Customizable board configuration
- JSON-based configuration for board layout
- Real-time updates via Livewire
- Generate multiple access URLs per board
- No authentication required for viewing
- Secure, unguessable tokens
- Optional expiration per URL
- Individual URL management and revocation
- Optimized for mobile and tablet viewing
- Touch-friendly interface
- Responsive layout using Tailwind CSS
- Clean, minimal interface using Flux UI Kit
- Drag-and-drop visual (readonly for clients)
- Color-coded lanes based on GitHub labels
- Issue cards showing title, assignee, and status
- Responsive grid that adapts to screen size
- Multiple URL structure for different access levels
- No login required for viewing
- Mobile-optimized touch interactions
- Fast loading with cached data
- Issue titles and descriptions
- Assignee avatars and names
- Creation and update dates
- Label indicators
- Status badges
- Issue numbers and URLs
- Author information and comments count
- Basic Laravel setup with Livewire
- GitHub API integration (single account via .env)
- Single Kanban board controller and view
- CLI commands for board management with UUID
- CLI commands for board URL management
- CLI commands for repository management
- CLI command for GitHub sync
- Board URL token generation and validation
- Basic label-to-lane mapping per repository
- Scheduled GitHub sync via cron
- Custom board configurations via JSON
- Mobile optimization
- Issue filtering options
- Multiple GitHub account support per repository
- Board templates
- Advanced filtering
- Analytics and usage tracking
- Custom themes
- API endpoints for external integration
- Page load time < 2 seconds
- API response time < 500ms
- Mobile usability score > 90
- Uptime > 99.9%
- Link sharing frequency
- Mobile usage percentage
- Return visits per board
- User feedback scores
This project includes comprehensive technical documentation in the docs/ directory:
Database Models & Schema
- Complete database schema with SQL definitions
- Eloquent model relationships and attributes
- JSON configuration examples
- Performance indexes and data flow
CLI Commands Reference
- Complete command reference with examples
- Board management commands
- Repository management commands
- GitHub sync commands
- Configuration and utility commands
Technical Architecture
- Technology stack and architecture diagram
- Core components and services
- Data flow and security architecture
- Performance optimization and deployment
- Read the concept - This README covers the business idea and features
- Review the architecture - Check docs/architecture.md for technical overview
- Understand the data model - See docs/models.md for database structure
- Learn the commands - Reference docs/commands.md for CLI usage
- Set up database migrations based on docs/models.md
- Implement CLI commands from docs/commands.md
- Create single Kanban controller and Livewire components
- Integrate GitHub API service
- Add advanced CLI commands
- Implement caching and performance optimizations
- Add mobile responsiveness
- Set up scheduled sync via cron
When adding new features or making changes:
- Update this README if business requirements change
- Document new models in docs/models.md
- Add command documentation in docs/commands.md
- Update architecture in docs/architecture.md if needed
- Markdown format for all documentation
- Code examples with proper syntax highlighting
- Clear structure with consistent headings
- Practical examples for all commands and features
- Cross-references between related documentation
- MIT License for maximum adoption
- Clear documentation for setup and usage
- Contributing guidelines for community
- Issue templates for bug reports and features
- Plugin system for custom integrations
- Theme marketplace for custom designs
- Community boards for sharing configurations
- Documentation wiki for user guides
This README covers both the business concept and technical implementation. For detailed technical documentation, see the docs/ directory.