Getting Started / Installation

# Installation

Zinq is a Laravel component library built with Livewire, Tailwind, and Alpine.js. It provides ready-to-use UI components that make building dynamic and modern Laravel applications faster and easier. It also includes powerful builders for tables and forms, allowing you to generate complex UIs with minimal code.

# Prerequisites

Zinq requires only Laravel and Livewire to work. Tailwind CSS is already included, so you don’t need to install it separately.

Laravel

Version 11+
Livewire

Version 3.5+

# Getting started

1
Install Zinq

Zinq can be installed using composer:

  
composer require mattb-it/zinq
Purchase Zinq License (recommended)

Each Zinq License includes the full set of components and gives you access to powerful table and form builders, making UI development even easier. If you haven’t purchased a Zinq license yet, you can find more details on our Pricing page.

  
composer config repositories.zinq '{"type": "composer", "url": "https://zinq.repo.repman.io"}'
composer config --global --auth http-basic.zinq.repo.repman.io token ${TOKEN}
composer require mattb-it/zinq-prime
2
Add Zinq assets

Add the following lines to your layout file to include Zinq assets:

  
<head>
    <!-- Add your custom scripts before @zinqStyles  -->
    @vite('...css')
    ...
    @zinqStyles
    @zinqHeadScripts
</head>
<body>
    @zinqScripts
</body>
3
Publish Zinq fonts (optional)

Read more about Zinq fonts configuration.

  
php artisan vendor:publish --tag=zinq-fonts

# Layouts

Once you have installed Zinq, you can discover Layouts and Components.

# Tailwind

Zinq is built using Tailwind CSS version 4, offering a modern and consistent design system. However, you don't need to install Tailwind in your project to use Zinq. The framework includes precompiled styles served through the @‎zinqStyles directive, ensuring seamless integration.