CLAUDE.md
CLAUDE.mdCLAUDE.mdroot
Quality
100/100
Scores the file, not the repository.Length
374 words
11 headings · 3 code blocksRepository
24k
— · pushed 0 days agoLast changed
3 days ago
First indexed 3 days ago.1# Project Overview23Livewire is a full-stack framework for Laravel. It allows you to build dynamic front-end applications without leaving the comfort of PHP/Laravel/Blade.45It is similar to projects like Phoenix Liveview however it isn't "live" in that it doesn't use real-time connections like websockets. Just simple http requests.67It renders on the server and uses morphing algorithm to path the DOM with updates from the server.89It "dehydrates" the state of a component into a JS-consumable object that is passed back to the server to be "hydrated" during the next request.1011# Tech Stack1213- Laravel + PHP + Vanilla JS14- JS Bundling: esbuild1516# Project Structure1718```19src/ → The PHP source files20- Features/ → Individual ~modules to isolate features21js/ → The JavaScript source files22tests/ → A smattering of PHP tests however, most tests are inside their src/Feature directories23```2425# Development Workflow2627## Setup2829Run `composer setup` to install all dependencies (PHP, JS, ChromeDriver).3031## Build JS assets3233Run `npm run build` to bundle the JS3435**IMPORTANT:** Do not commit `dist/` files. They are built in CI.3637# Code Patterns3839- Write JavaScript without semicolons40- Always use `let` (no `const`)41- Strive for single-word features and affordances (ex. `wire:click.stop` instead of `wire:click.stop-propagation`)4243# Testing4445Most browser and unit tests live inside of feature directories for example:4647src/Features/SupportSlots/[UnitTest.php|BrowserTest.php]4849```bash50composer test # all tests51composer test:unit # unit tests only52composer test:browser # browser tests (headless)53composer test:browser:headed # browser tests (opens Chrome)54composer test:browser -- --filter="SupportCSP" # specific browser tests55```5657**IMPORTANT:** Never run the full Livewire browser test suite — it takes too long. Always use `--filter` to run only the specific tests relevant to your changes. The full suite runs in CI.5859# Releasing6061## Bumping Alpine (optional)6263If you need to update the Alpine.js dependency before a release:6465```bash66npm run bump-alpine67```6869Then commit the updated `package.json` and `package-lock.json`.7071## Creating a release72731. Go to **Actions → "Release" → "Run workflow"**742. Enter the version number (e.g. `4.3.0` — the `v` prefix is added automatically)753. The workflow installs deps, builds assets, runs JS tests, creates a tag with the built `dist/` files, and creates a GitHub Release with auto-generated notes76
Similar configs
Same format, overlapping stack, ranked by quality.
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| nimbalyst/nimbalystpackages/android/CLAUDE.md · 1.4k | CLAUDE.md | setupbuildstylearch+2 | 100/100 | 3 days ago | |
| Adit-Jain-srm/NightmareNetCLAUDE.md · 45 | CLAUDE.md | buildtestlint-formatstyle+6 | 100/100 | 3 days ago | |
| filamentphp/filamentCLAUDE.md · 32k | CLAUDE.md | buildtestlint-formatstyle+7 | 100/100 | 3 days ago | |
| bagisto/bagistoCLAUDE.md · 28k | CLAUDE.md | setupbuildteststyle+5 | 100/100 | 3 days ago | |
| ruvnet/rufloruflo/src/ruvocal/CLAUDE.md · 67k | CLAUDE.md | setupbuildtestlint-format+6 | 97/100 | 3 days ago | |
| oven-sh/buntest/CLAUDE.md · 95k | CLAUDE.md | teststyletesting-strategydo-not | 97/100 | 3 days ago | |
| carrot-foundation/middle-earthCLAUDE.md · 0 | CLAUDE.md | setupbuildtestlint-format+6 | 97/100 | 3 days ago | |
| MetaMask/metamask-design-systemCLAUDE.md · 34 | CLAUDE.md | buildtestlint-formatstyle+5 | 97/100 | 3 days ago |
