Getting Started / Installation

Installation

# Introduction

Follow these simple steps to install and set up Zinq for your Laravel project. Zinq is compatible with Laravel 11+ and Livewire 3.5+, so please confirm your project meets these requirements before proceeding.

# Prerequisites

  1. Ensure you are using Laravel version 11.0+.
  2. Your project must have Livewire version 3.5+ installed.
  3. Purchase a Zinq license to access the toolkit. Upon completing your purchase, you will receive a unique token.

# Installation

  1. Purchase a Zinq license from our website. Once your payment is confirmed, a license token will be sent to your registered email.

  2. Open your terminal in the Laravel project directory and run this command to add a new composer repository:

      
    composer config repositories.zinq '{"type": "composer", "url": "https://zinq.repo.repman.io"}'

  3. Configure Composer package manager global authentication to access Zinq package:

      
    composer config --global --auth http-basic.zinq.repo.repman.io token ${TOKEN}

  4. Install Zinq package using Composer package manager

      
    composer require mattb-it/zinq

  5. Add Zinq assets

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

  6. (optionally) Publish Zinq fonts. Read more about Zinq fonts configuration

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

# Tailwind

Zinq is built using Tailwind CSS version 3, 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.