Reading the repo

Opening the box…

Assembly instructions

filamentphp/filament

An open-source framework for building polished, maintainable business software with Laravel.

Node.jsPHP#admin#alpine-js#builder#cms

Difficulty: Moderate
Time: about 15 min
Stars: ★ 32,420
Activity: Updated this month
License: MIT
Open issues: 15
Got it running: Be the first
Looked up: 4 h ago

Saved setup from 4 h ago

Start here

Website ↗filamentphp.comThe project's own site.

Setup script in the repo

The maintainers included bin/setup-playground.sh. Run it from the cloned folder after reading it.

bash bin/setup-playground.sh

Will it work on my device?

Yes, it runs on macOS

You'll build it yourself with Node.js, PHP.

Checking for

5 steps on macOS

Clone the repository

Needs Git: xcode-select --install

git clone https://github.com/filamentphp/filament.git
cd filament

Install the required runtimes

Node.js lts, PHP ^8.2

# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm)
nvm install --lts
brew install php composer

3
Configure environment variables
Fill in secrets: APP_KEY, REDIS_PASSWORD, MAIL_PASSWORD, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY
```
cp .env.testing.example .env
```
4
Install dependencies
```
npm ci
composer install
```
5
Run it
```
npm run dev
```

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 11 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js ltsruntime
1×PHP ^8.2runtime
1×npm package manager
1×composer package manager

44× settings in .env

DB_HOST
APP_NAME
APP_ENV
APP_KEYsecret
APP_DEBUG
APP_URL
APP_LOCALE
APP_FALLBACK_LOCALE
APP_FAKER_LOCALE
APP_MAINTENANCE_DRIVER
BCRYPT_ROUNDS
LOG_CHANNEL
LOG_STACK
LOG_DEPRECATIONS_CHANNEL
LOG_LEVEL
DB_CONNECTION
SESSION_DRIVER
SESSION_LIFETIME
SESSION_ENCRYPT
SESSION_PATH
SESSION_DOMAIN
BROADCAST_CONNECTION
FILESYSTEM_DISK
QUEUE_CONNECTION
CACHE_STORE
MEMCACHED_HOST
REDIS_CLIENT
REDIS_HOST
REDIS_PASSWORDsecret
REDIS_PORT
MAIL_MAILER
MAIL_SCHEME
MAIL_HOST
MAIL_PORT
MAIL_USERNAME
MAIL_PASSWORDsecret
MAIL_FROM_ADDRESS
MAIL_FROM_NAME
AWS_ACCESS_KEY_IDsecret
AWS_SECRET_ACCESS_KEYsecret
AWS_DEFAULT_REGION
AWS_BUCKET
AWS_USE_PATH_STYLE_ENDPOINT
VITE_APP_NAME

Share this manual

Good to know

Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: docs-assets/app/composer.json, docs-assets/app/package.json, docs-assets/screenshots/package.json, packages/actions/composer.json and 11 more

package.json scripts (11)

test:jsnode --test tests/js/*.test.js
dev:jsnode bin/build.js --dev
dev:forms-csscp ./packages/forms/dist/index.css ./packages/forms/dist/tmp.css && npx @tailwindcss/cli -i ./packages/forms/dist/tmp.css -o ./packages/forms/dist/index.css --watch && rm ./packages/forms/dist/tmp.css
dev:panels-cssnpx @tailwindcss/cli -i ./packages/panels/resources/css/theme.css -o ./packages/panels/dist/theme.css --watch
devnpm-run-all --parallel dev:*
build:jsnode bin/build.js
build:forms-csscp ./packages/forms/dist/index.css ./packages/forms/dist/tmp.css && npx @tailwindcss/cli -i ./packages/forms/dist/tmp.css -o ./packages/forms/dist/index.css --minify && rm ./packages/forms/dist/tmp.css
build:panels-cssnpx @tailwindcss/cli -i ./packages/panels/resources/css/theme.css -o ./packages/panels/dist/theme.css --minify
buildnpm-run-all build:*
build-demonpm run build && cd ../demo && php artisan filament:upgrade && cd ../filament && cd docs-assets/app && php artisan filament:upgrade && npm run build && cd ../../
prettiernpx prettier --write --cache --cache-location=.prettiercache .

Files we read (11)

.env.testing.example

.github/workflows/check-pr-maintainer-access.yml

.github/workflows/format-and-build.yml

.github/workflows/issue-reproduction-template.yml

.github/workflows/manage-issue.yml

.github/workflows/monorepo-split.yml

.github/workflows/tests.yml

README.md

composer.json

docs-assets/app/.env.example

package.json

Branch 4.x · 8,551 files in the repo