Getting Started

Installation

Install and configure Tapix in your Laravel and Filament application.

Requirements

Before installing Tapix, ensure your application meets the following requirements:

  • PHP 8.4 or higher
  • Laravel 12 or higher
  • Filament 5 or higher
  • Tailwind CSS 4 or higher
  • A supported database: MySQL, PostgreSQL, or SQLite

License

Tapix is a commercial package. You must purchase a license at tapix.dev before installing.

After purchase, you will receive credentials to access the private Composer repository. Keep these credentials secure and do not commit them to version control.

Installation

Add the Tapix repository

Register the private Tapix Composer repository in your project:

Terminal
composer config repositories.tapix composer https://tapix.dev/repo

When prompted, enter the credentials you received after purchasing your license.

Install the package

Terminal
composer require tapix/core

Publish the configuration

Publish the Tapix configuration file:

Terminal
php artisan vendor:publish --tag=tapix-config

This creates config/tapix.php. See the Configuration page for a full reference of available options.

Run migrations

Tapix requires several database tables to track imports, mappings, and row data:

Terminal
php artisan migrate

Include Tapix CSS

Tapix ships with styles that must be included in your Tailwind CSS build.

With Filament

Add the Tapix source path to your tailwind.config.js content array:

tailwind.config.js
export default {
    content: [
        // ...existing paths
        './vendor/tapix/core/resources/**/*.blade.php',
    ],
}

Without Filament

If you are using Tapix outside of a Filament panel, add the same content path and import the Tapix CSS in your main stylesheet:

resources/css/app.css
@import '../../vendor/tapix/core/resources/css/tapix.css';
Without the Tapix content path in your Tailwind configuration, the import wizard will render without proper styling.

Register the Filament plugin

Add TapixPlugin to your Filament panel provider. The discoverImporters() method automatically finds all importer classes in your configured importer directories.

app/Providers/Filament/AdminPanelProvider.php
use Tapix\Core\Filament\TapixPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            TapixPlugin::make()
                ->discoverImporters(),
        ]);
}

Create your first importer

Generate an importer class using the Artisan command:

Terminal
php artisan make:tapix-importer ContactImporter

This creates a new importer at app/Importers/ContactImporter.php. Open the file and define your column mappings, validation rules, and processing logic. See the Defining Importers section for detailed guidance.

Verification

After completing the installation steps:

  1. Start your development server and navigate to your Filament admin panel.
  2. Look for the Import navigation item in the sidebar.
  3. Click it to confirm the import wizard loads correctly.

If the navigation item does not appear, verify that:

  • TapixPlugin is registered in your panel provider.
  • You have at least one importer class in your configured importer directory.
  • You have run php artisan migrate to create the required tables.
  • Your Filament panel cache is cleared: php artisan filament:clear-cached-components.
Copyright © 2026