livewire

(β˜… 23,573)

A full-stack framework for Laravel that takes the pain out of building dynamic UIs.

  • .editorconfig
  • .gitattributes
  • .gitignore
  • .prettierrc
  • .styleci.yml
  • CLAUDE.md
  • close.bash
  • composer.json
  • LICENSE.md
  • package-lock.json
  • package.json
  • phpunit.xml.dist
  • PRD-wire-model-modifiers.md
  • README.md
  • test_unified_scripts.php
  • vercel.json
  • vitest.config.js

# Installation Guide

1. Get the code
git clone https://github.com/livewire/livewire

Downloads the entire project code from GitHub to your computer.

cd livewire

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

3. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
composer setup

Type this command into your terminal and run it.

composer test:unit # unit tests

Type this command into your terminal and run it.

composer test:browser # browser tests (headless)

Type this command into your terminal and run it.

composer test:browser:headed # browser tests (opens Chrome)

Type this command into your terminal and run it.

composer test:browser -- --filter="SupportCSP" # specific tests

Type this command into your terminal and run it.

βœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation