|
| 1 | +# Laravel Console Starter |
| 2 | + |
| 3 | +A streamlined Laravel starter kit for building applications with custom artisan commands. |
| 4 | + |
| 5 | +This starter kit accelerates the development of Laravel applications that primarily use artisan commands for their functionality. Instead of building standalone CLI tools, you create powerful Laravel console applications that leverage the full Laravel framework ecosystem - including dependency injection, notifications, scheduling, and testing tools. Perfect for building scheduled tasks, data processing workflows, monitoring scripts, and automated maintenance tools that benefit from Laravel's robust architecture without the web application overhead. |
| 6 | + |
| 7 | +[](https://deepwiki.com/invokable/laravel-console-starter) |
| 8 | + |
| 9 | +> **Note:** If you would like to create a console only project based on the latest official Laravel skeleton, you can also use the [laravel-slim](https://github.com/invokable/laravel-slim) package. |
| 10 | +
|
| 11 | + |
| 12 | +## Key Features |
| 13 | +- **Focus on Console Applications:** Streamlined for building Laravel applications with artisan commands, removing web-specific overhead. |
| 14 | +- **Artisan Command Ready:** Quickly generate and organize your console commands using `php artisan make:command`. |
| 15 | +- **Scheduled Tasks with GitHub Actions:** Includes a pre-configured example (`.github/workflows/cron.yml`) for running your commands on a schedule using GitHub Actions. |
| 16 | +- **Laravel Framework Power:** Leverage familiar Laravel features like its robust dependency injection container, event system, configuration management, and application testing tools for your console applications. |
| 17 | + |
| 18 | +## Requirements |
| 19 | +- PHP ^8.3 |
| 20 | +- Laravel Framework ^13.0 |
| 21 | +- Laravel Installer ^5.24 |
| 22 | + |
| 23 | +## Installation |
| 24 | + |
| 25 | +```shell |
| 26 | +laravel new --using=revolution/laravel-console-starter --no-interaction my-app |
| 27 | +``` |
| 28 | + |
| 29 | +## Usage |
| 30 | + |
| 31 | +### Make a new command |
| 32 | + |
| 33 | +```shell |
| 34 | +php artisan make:command Hello --command=hello |
| 35 | +``` |
| 36 | +This will create a new command class in `app/Console/Commands/Hello.php`. The `--command=hello` option sets the invokable name of your command, so you can run it later using `php artisan hello`. |
| 37 | + |
| 38 | +### Task Scheduling in GitHub Actions |
| 39 | + |
| 40 | +[cron.yml](./.github/workflows/cron.yml) is an example of how to run the command in GitHub Actions. |
| 41 | +This workflow file demonstrates how to set up a cron-like schedule to execute your Artisan commands automatically. You'll need to customize it with the specific commands you want to run and their desired frequency. Remember to configure repository secrets for any sensitive information your commands might need (e.g., API keys, database credentials). |
| 42 | + |
| 43 | +## Notifications |
| 44 | + |
| 45 | +Laravel's built-in notification system provides a convenient way to send notifications from your console commands. This is particularly useful for: |
| 46 | + |
| 47 | +- Alerting you when a long-running task completes. |
| 48 | +- Reporting errors or issues encountered during command execution. |
| 49 | +- Sending updates or summaries to email, Slack, or other chat platforms. |
| 50 | + |
| 51 | +To use this feature, you'll typically create a notification class (e.g., using `php artisan make:notification TaskCompleted`) and then send it using the `Notification` facade. You will need to configure your desired notification channels (like mail, Slack, etc.) in your Laravel application. When configuring notification channels, especially those relying on external services or specific mail drivers, you may need to publish the relevant configuration files if they don't already exist in your `config` directory. You can do this using the following Artisan commands: |
| 52 | + |
| 53 | +```shell |
| 54 | +php artisan config:publish mail |
| 55 | +php artisan config:publish services |
| 56 | +``` |
| 57 | + |
| 58 | +The `config/mail.php` file allows you to configure your mailer settings, while `config/services.php` is used to store credentials and settings for various third-party services that Laravel can integrate with for notifications (e.g., Slack, Vonage). For detailed setup and usage, please refer to the official [Laravel Notification documentation](https://laravel.com/docs/notifications). |
| 59 | + |
| 60 | +## Application Ideas |
| 61 | + |
| 62 | +Here are some ideas for applications that can be built using this starter kit: |
| 63 | + |
| 64 | +### Monitoring and Analytics |
| 65 | +- Website uptime monitoring with Slack alerts |
| 66 | +- Server resource usage reports via email |
| 67 | +- SSL certificate expiration checks and email notifications |
| 68 | +- Competitor price change tracking with Discord notifications |
| 69 | +- API response time monitoring and alerts |
| 70 | +- Website performance score (Lighthouse) periodic checks |
| 71 | + |
| 72 | +### Finance and Business |
| 73 | +- Send Google AdSense revenue via email |
| 74 | +- Notify AWS costs to Discord |
| 75 | +- Daily cryptocurrency portfolio updates to Discord |
| 76 | +- Stock price alerts to Slack channels |
| 77 | +- Invoice payment deadline reminders |
| 78 | +- Monthly expense report generation and delivery |
| 79 | +- Subscription renewal alerts |
| 80 | + |
| 81 | +### Data Processing and Reports |
| 82 | +- Old log file cleanup and storage space reports |
| 83 | +- Data synchronization between different APIs with result reports |
| 84 | +- CSV data import and processing result notifications |
| 85 | +- Cache cleanup and optimization reports |
| 86 | +- Periodic data exports and uploads to cloud storage |
| 87 | + |
| 88 | +### Content and Marketing |
| 89 | +- Website broken link checks and reports |
| 90 | +- SEO keyword ranking monitoring and change notifications |
| 91 | +- Social media follower count change reports |
| 92 | +- Blog post performance metrics weekly reports |
| 93 | +- Content publication schedule reminders |
| 94 | +- RSS feed content aggregation and notifications |
| 95 | +- Email marketing campaign result reports |
| 96 | + |
| 97 | +### Development and DevOps |
| 98 | +- GitHub repository dependency security alerts |
| 99 | +- Codebase static analysis reports |
| 100 | +- Test coverage report generation and notifications |
| 101 | +- Post-deployment application health checks |
| 102 | +- Unused cloud resource detection and notifications |
| 103 | +- API documentation change detection and notifications |
| 104 | +- Codebase TODO comment aggregation and reminders |
| 105 | + |
| 106 | +### Personal Productivity |
| 107 | +- Daily morning weather forecast notifications |
| 108 | +- Calendar event daily summaries |
| 109 | +- Habit tracking and reminders |
| 110 | +- Subscription service renewal date notifications |
| 111 | +- Important dates and anniversary reminders |
| 112 | +- Regular backup reminders |
| 113 | +- Health data aggregation and trend reports |
| 114 | + |
| 115 | +### Additional Ideas |
| 116 | + |
| 117 | +- Building AI agent tools using [laravel-copilot-sdk](https://github.com/invokable/laravel-copilot-sdk) etc. |
| 118 | +- Building a local MCP server using the [laravel/mcp](https://github.com/laravel/mcp) package |
| 119 | +- Domain expiration monitoring and alerts |
| 120 | +- Suspicious access pattern detection from server logs |
| 121 | +- Unusual financial transaction detection reports |
| 122 | +- Automated OCR processing and results summary |
| 123 | +- Google Trends keyword monitoring and notifications |
| 124 | +- YouTube channel performance data aggregation |
| 125 | +- CI/CD failure trend analysis |
| 126 | +- Laravel package update detection alerts |
| 127 | +- Personal spending category insights and visual reports |
| 128 | +- Daily journal sentiment analysis and summaries |
| 129 | + |
| 130 | +## Documentation |
| 131 | + |
| 132 | +For detailed usage instructions and examples, please refer to our comprehensive tutorials: |
| 133 | + |
| 134 | +- [Tutorial (English)](./docs/tutorial.md) |
| 135 | +- [チュートリアル (日本語)](./docs/tutorial_ja.md) |
| 136 | +- [Database](./docs/database.md) |
| 137 | + |
| 138 | +## LICENSE |
| 139 | +MIT |
0 commit comments