Add comprehensive project documentation and architecture guidelines
Establishes core rules and conventions for the FuelAlert Laravel application: architecture patterns (fat services, thin controllers), database schema with partitioned station_prices table, multi-tier notification system with Vonage and OneSignal, 4-signal scoring engine for fuel price recommendations, Stripe subscription tiers, Livewire classic component structure, and Pest testing standards.
This commit is contained in:
38
CLAUDE.md
Normal file
38
CLAUDE.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# FuelAlert — Claude Code Instructions
|
||||
|
||||
UK fuel price intelligence app. Subscribers receive fill-up timing recommendations
|
||||
based on local price trends. Built solo by a PHP/Laravel developer.
|
||||
|
||||
## Project overview
|
||||
|
||||
- **Product**: "Fill up now or wait?" — local fuel price trend scoring for UK drivers
|
||||
- **Monetisation**: £0/mo free, £0.99/mo Basic, £2.49/mo Plus, £3.99/mo Pro
|
||||
- **Stack**: Laravel 11 + Livewire 3 (Volt disabled — use classic components) + Alpine.js + Tailwind CSS
|
||||
- **Database**: MySQL — Eloquent ORM, migrations only (no raw DDL)
|
||||
- **Payments**: Stripe via Laravel Cashier
|
||||
- **Notifications**: Laravel Notification channels — email, WhatsApp (Vonage), SMS (Vonage), push (OneSignal)
|
||||
- **Queue**: Laravel queues with Redis driver (notifications and polling jobs)
|
||||
- **Scheduler**: Laravel scheduler for Fuel Finder API polling and scoring
|
||||
|
||||
## Key commands
|
||||
|
||||
```bash
|
||||
php artisan serve # Local dev server
|
||||
php artisan queue:work # Process notification jobs
|
||||
php artisan schedule:run # Run scheduled commands (cron every minute)
|
||||
php artisan migrate # Run migrations
|
||||
php artisan test # Run Pest test suite
|
||||
npm run dev # Vite asset watcher
|
||||
```
|
||||
|
||||
## Imports
|
||||
|
||||
@.claude/rules/architecture.md
|
||||
@.claude/rules/database.md
|
||||
@.claude/rules/notifications.md
|
||||
@.claude/rules/scoring.md
|
||||
@.claude/rules/payments.md
|
||||
@.claude/rules/livewire.md
|
||||
@.claude/rules/api-data.md
|
||||
@.claude/rules/testing.md
|
||||
@.claude/rules/code-style.md
|
||||
Reference in New Issue
Block a user