Installation

Get started with Velyx in your Laravel project

Installation

Get started with Velyx in your Laravel project.

Prerequisites

Before using Velyx, make sure you have:

  • Laravel 10 or higher
  • Livewire 3 or higher (if using Livewire components)
  • Node.js 20 or higher
  • PHP 8.2 or higher
  • Tailwind CSS v4 installed in your project

No Installation Required
Velyx works via npx — no global installation needed! Just ensure you have Node.js 20+ in your Laravel project.

Initialize Velyx

Run the init command in your Laravel project:

npx velyx add button
pnpm dlx velyx add button
yarn dlx velyx add button
bunx --bun velyx add button

This will:

  1. Create a velyx.json file in your project root
  2. Check your project environment
  3. Prepare the component setup for your app

Add Your First Component

Browse the components library and add components to your project:

npx velyx add button
pnpm dlx velyx add button
yarn dlx velyx add button
bunx --bun velyx add button

Components are copied directly into your project — you own the code and can customize them however you want.

Note: Make sure to commit your changes before adding components, as Velyx will copy files into your project.

What's Next?