{"id":28926546,"url":"https://github.com/nahime0/planka-companion","last_synced_at":"2026-04-30T07:37:17.914Z","repository":{"id":300201098,"uuid":"1002897386","full_name":"nahime0/planka-companion","owner":"nahime0","description":"A PHP / Laravel / Filament companion for Planka with notifications and other missing features","archived":false,"fork":false,"pushed_at":"2025-06-20T10:39:24.000Z","size":803,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-20T11:37:08.239Z","etag":null,"topics":["filament","laravel","php","planka","project-manager"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nahime0.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-16T10:06:43.000Z","updated_at":"2025-06-20T10:39:29.000Z","dependencies_parsed_at":"2025-06-20T11:48:24.352Z","dependency_job_id":null,"html_url":"https://github.com/nahime0/planka-companion","commit_stats":null,"previous_names":["nahime0/planka-companion"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nahime0/planka-companion","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nahime0%2Fplanka-companion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nahime0%2Fplanka-companion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nahime0%2Fplanka-companion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nahime0%2Fplanka-companion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nahime0","download_url":"https://codeload.github.com/nahime0/planka-companion/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nahime0%2Fplanka-companion/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261289428,"owners_count":23136071,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["filament","laravel","php","planka","project-manager"],"created_at":"2025-06-22T12:11:18.992Z","updated_at":"2026-04-30T07:37:17.908Z","avatar_url":"https://github.com/nahime0.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Planka Companion\n\n\u003e **DISCLAIMER**: This project is currently in active development and is **NOT** suitable for production use. Features may be incomplete, APIs may change, and bugs may exist. Use at your own risk.\n\nA Laravel-based companion application for [Planka](https://github.com/plankanban/planka) that extends its functionality with advanced features like expiration notifications, enhanced card management, and Telegram integration.\n\n## Why Planka Companion?\n\nWhile Planka is an excellent open-source project management tool, it lacks some essential features for teams that need:\n- **Expiration Notifications**: Get notified before cards expire\n- **External Notifications**: Telegram integration for real-time updates\n- **Advanced Card Management**: Better visibility of expiring and overdue cards\n- **Notification History**: Track all notifications sent for audit purposes\n\nPlanka Companion fills these gaps without modifying Planka's core database, ensuring compatibility and easy updates.\n\n## Features\n\n### Card Expiration Management\n- **30-minute warnings** before card due dates\n- **Daily reminders** for overdue cards (sent after 10 AM)\n- **Smart notification system** that prevents duplicate alerts\n- **Visual indicators** for overdue cards in the interface\n\n### Telegram Integration\n- Send notifications to card creators and subscribers\n- Customizable notification messages\n- Support for multiple notification scenarios\n- Full notification history tracking\n\n### Enhanced Card Views\n- **Hierarchical display**: Project → Board → List → Card\n- **Recently updated cards widget** on dashboard\n- **Advanced filtering** by board, list, due date, and overdue status\n- **Card statistics** at a glance (comments, attachments, members, tasks)\n\n### Notification Tracking\n- Complete history of all notifications sent\n- View notification logs per card\n- Track who was notified and when\n- Prevent notification fatigue with intelligent deduplication\n\n## Requirements\n\n- PHP 8.2 or higher\n- PostgreSQL (for Planka database connection)\n- SQLite or MySQL/PostgreSQL (for companion app data)\n- Composer\n- A running Planka instance\n- Telegram Bot Token (for notifications)\n\n## Installation\n\n1. **Clone the repository**\n   ```bash\n   git clone https://github.com/nahime/planka-companion.git\n   cd planka-companion\n   ```\n\n2. **Install dependencies**\n   ```bash\n   composer install\n   ```\n\n3. **Configure environment**\n   ```bash\n   cp .env.example .env\n   php artisan key:generate\n   ```\n\n4. **Set up database connections**\n   \n   Edit `.env` and configure your Planka database connection:\n   ```env\n   # Planka Database Connection\n   PLANKA_DB_HOST=your-planka-host\n   PLANKA_DB_PORT=5432\n   PLANKA_DB_DATABASE=planka\n   PLANKA_DB_USERNAME=planka\n   PLANKA_DB_PASSWORD=your-password\n   ```\n\n5. **Configure Telegram (optional)**\n   ```env\n   TELEGRAM_BOT_TOKEN=your-bot-token\n   TELEGRAM_CHAT_ID=your-chat-id\n   ```\n\n6. **Run migrations**\n   ```bash\n   php artisan migrate\n   ```\n\n7. **Start the application**\n   ```bash\n   php artisan serve\n   ```\n\n8. **Set up the scheduler**\n   \n   Add this cron entry to run Laravel's scheduler:\n   ```bash\n   * * * * * cd /path-to-your-project \u0026\u0026 php artisan schedule:run \u003e\u003e /dev/null 2\u003e\u00261\n   ```\n\n## Usage\n\n### Accessing the Dashboard\n\nNavigate to `http://localhost:8000/admin` and log in using your Planka credentials.\n\n### Viewing Cards\n\nThe dashboard shows recently updated cards. You can:\n- Click on any card to view details\n- See notification history for each card\n- Filter cards by various criteria\n- Access cards directly in Planka\n\n### Notifications\n\nNotifications are sent automatically based on the schedule:\n- **Expiring cards**: Checked every minute, notified 30 minutes before due date\n- **Expired cards**: Daily notifications sent after 10 AM\n\n### Manual Notification Command\n\nYou can also run notifications manually:\n```bash\nphp artisan cards:notify-expiring\n```\n\n## Architecture\n\nPlanka Companion follows a **read-only** approach to Planka's database:\n- Never modifies Planka tables directly\n- Maintains its own database for companion-specific data\n- Uses separate database connections for clean separation\n\n## Development\n\n### Code Style\n```bash\ncomposer lint      # Run PHP linter\ncomposer typecheck # Run static analysis\ncomposer test      # Run tests\n```\n\n### Project Guidelines\n\n## Important Notes\n\n**Never modify Planka database tables directly** - This is a core principle of Planka Companion\n\n**Telegram Notifications** - Currently, all users share the same Telegram chat ID. Individual user chat IDs will be supported in future versions.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is open source and available under the [MIT License](LICENSE).\n\n## Acknowledgments\n\n- [Planka](https://github.com/plankanban/planka) - The amazing project management tool this companion extends\n- [Laravel](https://laravel.com) - The PHP framework\n- [Filament](https://filamentphp.com) - The admin panel builder\n\n## Support\n\nIf you find this project helpful, please give it a ⭐ on GitHub!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnahime0%2Fplanka-companion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnahime0%2Fplanka-companion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnahime0%2Fplanka-companion/lists"}