livewire README

The project's README from github.com/livewire/livewire. As one markdown file: README.md.

Livewire Logo

Total Downloads Latest Stable Version License

Introduction

Livewire is a full-stack framework for Laravel that allows you to build dynamic UI components without leaving PHP.

Official Documentation

You can read the official documentation on the Livewire website.

Local Development

git clone [email protected]:livewire/livewire.git && cd livewire
composer setup

This installs PHP and JS dependencies and sets up ChromeDriver for browser tests.

composer test:unit                                   # unit tests
composer test:browser                                # browser tests (headless)
composer test:browser:headed                         # browser tests (opens Chrome)
composer test:browser -- --filter="SupportCSP"       # specific tests

To build the JS assets after making changes: npm run build

Contributing

Thank you for considering contributing to Livewire! You can read the contribution guide here.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by Laravel's Code of Conduct.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

Livewire is open-sourced software licensed under the MIT license.

livewire (livewire/livewire)

Searching Database…

23.6K ·GitHub
What is this?Livewire is a full-stack framework for Laravel for building dynamic UI components. The idea is that you write the interactivity in PHP instead of switching to JavaScript.
Is it a standalone app, or something I add to my existing Laravel project?It is a framework that lives inside a Laravel app: you add it to a Laravel project and write dynamic UI components on top of it. It is not a separate service or tool you run on its own.
How do I get it installed?Install steps are in the official documentation on the Livewire website — the README has no install command. Working on Livewire itself starts with installing the PHP and JS dependencies plus ChromeDriver.
Do I need to know JavaScript to use it?No — that is the whole pitch: you build dynamic UI components while staying in PHP. The client-side part is handled by the framework itself.
What actually powers the interactivity in the browser?Livewire ships a JavaScript runtime built around Alpine.js — the repo bundles alpinejs plus @alpinejs plugins such as morph, focus, intersect, collapse and persist.
How is Livewire itself developed and tested?Local dev installs PHP and JS dependencies and sets up ChromeDriver; JS tests run on vitest and browser tests use ChromeDriver. CI workflows cover pull requests and the 4.x branch, and JS assets are rebuilt with npm run build.
How established is the project?It is part of the Laravel ecosystem with docs on the official Livewire website, has been open source under MIT since February 2019, and has about 23.6k stars on GitHub.
What are similar projects?filament, symfony, laravel, wasp, framework, next.js, blitz, riot
Creator
livewire
Size
49.2 MB
Stars
23.6K
Age
7y
Commits · 90 Days