Qore.works Business

Appearance

Installation ​

Upgrading from 1.x? See the Upgrade Guide.

Requirements ​

The qore-admin-base package requires a fresh Laravel installation:

bash
composer create-project laravel/laravel project-name
cd project-name

Add the private package repositories:

bash
composer config repositories.filament composer https://packages.filamentphp.com/composer
composer config repositories.dolphiq composer https://dolphiq.repo.packagist.com/packages/

Configure your environment to use the correct database connection:

dotenv
DB_CONNECTION=mysql
DB_HOST=db
DB_PORT=3306
DB_DATABASE=database_name
DB_USERNAME=db
DB_PASSWORD=db@123

Installation ​

  1. Install the package via composer:
bash
composer require qore-works-business/qore-admin-base:^v2.0 --with-all-dependencies

Tip: The --with-all-dependencies flag ensures Composer can update existing packages to resolve any dependency conflicts.

  1. Run the artisan install script:
bash
php artisan qore-admin-base:install

The installer will prompt you to install recommended development packages. To skip the prompt and automatically install them:

bash
php artisan qore-admin-base:install --dev-packages
  1. Install npm dependencies and build frontend assets:
bash
npm install
npm run build

Optional Configuration ​

Publish and run the provided seeders. Note: This will overwrite your DatabaseSeeder.php file.

bash
php artisan vendor:publish --tag="qore-admin-base-seeders" --force
php artisan db:seed

Publish the translations:

bash
php artisan vendor:publish --tag="qore-admin-base-translations"

Publish the views:

bash
php artisan vendor:publish --tag="qore-admin-base-views"

Updating Existing Projects ​

For existing projects, see the Commands page for maintenance commands:

  • qore-admin-base:publish-stubs - Update default stub files (tests, config)
  • qore-admin-base:update-composer-scripts - Add missing composer scripts

The --dev-packages option installs the following packages:

  • barryvdh/laravel-ide-helper - IDE autocompletion
  • itsgoingd/clockwork - Debugging and profiling
  • larastan/larastan - Static analysis
  • pestphp/pest - Testing framework
  • pestphp/pest-plugin-laravel - Laravel-specific Pest helpers
  • pestphp/pest-plugin-livewire - Livewire-specific Pest helpers
  • qore-works-business/pest-plugin-qore - Qore-specific Pest helpers

If you prefer to install them manually:

bash
composer remove phpunit/phpunit --dev --no-update
composer require barryvdh/laravel-ide-helper itsgoingd/clockwork larastan/larastan pestphp/pest pestphp/pest-plugin-laravel pestphp/pest-plugin-livewire qore-works-business/pest-plugin-qore --no-update --dev
composer update
php ./vendor/bin/pest --init