OptimeHub

A modern Laravel-based status page and incident management system built with Filament admin panel.

Features

• Status Monitoring: Track service availability and performance
• Incident Management: Create, update, and resolve incidents with timeline tracking
• Scheduled Maintenance: Plan and communicate maintenance windows
• Subscriber Notifications: Keep users informed via email subscriptions
• Admin Dashboard: Powerful Filament-based administration interface
• Real-time Updates: Livewire-powered dynamic interface

Requirements

• PHP 8.4+
• Composer
• Node.js & NPM
• SQLite (or other supported database)

Installation

1. Clone the repository

   git clone <repository-url>
   cd optimeHub

2. Install PHP dependencies

   composer install

3. Install JavaScript dependencies

   npm install

4. Environment setup

   cp .env.example .env
   php artisan key:generate

5. Database setup

   php artisan migrate
   php artisan db:seed

6. Build assets

   npm run build
   # or for development
   npm run dev

Development

Running the Application

Using Laravel Sail (recommended):

./vendor/bin/sail up

Or using PHP's built-in server:

php artisan serve

Available Commands

• Code formatting: vendor/bin/pint
• Static analysis: vendor/bin/phpstan analyse
• Run tests: php artisan test
• Browser tests: php artisan test tests/Browser

Frontend Development

# Watch for changes
npm run dev

# Build for production
npm run build

# Format JavaScript/CSS
npx prettier --write resources/

Tech Stack

• Backend: Laravel 12.26.2 with PHP 8.4
• Admin Panel: Filament 4.0.3
• Frontend: Livewire 3.6.4 + Alpine.js + Tailwind CSS 4.1.12
• Testing: Pest 4.0.3 with browser testing support
• Code Quality: Laravel Pint, PHPStan/Larastan, Rector

Project Structure

app/
├── Filament/         # Filament admin resources
├── Models/           # Eloquent models
│   ├── Incident.php
│   ├── Service.php
│   ├── ScheduledMaintenance.php
│   └── StatusPageSubscriber.php
├── Http/             # Controllers and middleware
└── Livewire/         # Livewire components

database/
├── migrations/       # Database migrations
├── factories/        # Model factories
└── seeders/          # Database seeders

resources/
├── views/            # Blade templates
├── js/               # JavaScript assets
└── css/              # Stylesheets

tests/
├── Feature/          # Feature tests
├── Unit/             # Unit tests
└── Browser/          # Browser tests

Testing

Run the full test suite:

php artisan test

Run specific test types:

# Feature tests
php artisan test tests/Feature

# Unit tests  
php artisan test tests/Unit

# Browser tests
php artisan test tests/Browser

Run with coverage:

php artisan test --coverage

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions:

1. Check the documentation
2. Search existing issues
3. Create a new issue with detailed information

Changelog

See CHANGELOG.md for a detailed list of changes and updates.