Skip to content

Latest commit

 

History

History
68 lines (60 loc) · 1.99 KB

File metadata and controls

68 lines (60 loc) · 1.99 KB

Installation Guide

Prerequisites

  • PHP 8.3+ with the following extensions: pdo_mysql, redis, gd/imagick, mbstring, xml, zip, bcmath, intl.
  • MySQL 8.0+ or MariaDB equivalent.
  • Redis 7.0+ (for caching, sessions, and queues).
  • Node.js 20+ and npm (for asset compilation).
  • Composer 2.x (for PHP dependency management).
  • Mailpit (optional, for local development).

Local Development Setup

  1. Clone the repository:
    git clone https://github.com/your-repo/eventra.git
    cd eventra
  2. Install PHP dependencies:
    composer install
  3. Install Node dependencies:
    npm install
  4. Set up environment variables:
    cp .env.example .env
    php artisan key:generate
  5. Configure .env: Edit your .env file and set the correct database, Redis, and mail server credentials.
  6. Run migrations and seed the database:
    php artisan migrate --seed
  7. Initialize Filament Shield:
    php artisan shield:install
  8. Link storage:
    php artisan storage:link
  9. Build frontend assets:
    npm run build
  10. Start the development server:
    php artisan serve
    Your application will be available at http://localhost:8000.

Development Workflow

  • Asset Compilation: Use npm run dev to watch for changes during development.
  • Queues: Use php artisan queue:listen or set up Horizon for local background job monitoring.
  • Telescope: Visit /telescope to inspect application requests, exceptions, and more.
  • Mailpit: If local development mail is configured, the web interface is usually at http://localhost:8025.

Common Commands

  • Run tests: php artisan test
  • Run linter: composer lint
  • Static analysis: composer analyze
  • Pre-commit hooks: pre-commit run --all-files