Installation

One prompt.
BankBird is running.

No terminal, no manual fiddling. With Laravel Herd and an AI assistant like Claude or Codex, the entire setup takes just four steps.

⚡

Four steps

From clone to running in a matter of minutes

🔁

Always available

Herd starts with your computer — nothing to launch ever again

🐦

bankbird.test

Your own local address in the browser, no port numbers

✨ AI installation assistant

Barely any technical knowledge needed

BankBird ships with a built-in AGENTS.md install protocol. Open Claude Code or Codex inside the project folder, paste the prompt below — and the agent takes it from there.

Download Herd

prompt.txt

Install BankBird (github.com/AivionStudiosPlayground/bankbird) for me.

One line is all it takes. The agent reads the End-user installation protocol inside AGENTS.md and runs through every step on its own.

Jump to: 1️⃣ Herd 2️⃣ Clone 3️⃣ Prompt 4️⃣ Done HTTPS (optional) Advanced Troubleshooting

Install Laravel Herd

One-time setup — bundles PHP, Composer and Node, runs in the background

Herd is a free tool from the Laravel team. It installs everything BankBird needs and keeps your app running in the background at http://bankbird.test — even after a restart.

Download Laravel Herd Available for Windows and macOS · Free

💡

Don't have Herd yet? Ask Claude/Codex to install it — the agent downloads the installer and you only need to click "Yes" once on the Windows security prompt (UAC).

Clone the repository

Download the source code wherever you like

Open a terminal (Herd includes one — or use Windows Terminal / iTerm), navigate to where you want to save BankBird, and run:

bash

git clone --single-branch --branch master --depth 1 https://github.com/AivionStudiosPlayground/bankbird.git
cd bankbird

Ask Claude or Codex

One prompt — the agent handles the rest

Open Claude Code or Codex CLI inside the project folder and give it this prompt:

prompt

Install BankBird (github.com/AivionStudiosPlayground/bankbird) for me.

📜

The agent follows the End-user installation protocol from AGENTS.md: detecting Herd, installing dependencies, linking the project to Herd (herd link bankbird), setting up the database, creating an admin account and running a smoke test on the login page.

Open your browser

Available forever — no server to start, no terminal

Once the agent confirms everything is ready:

browser

http://bankbird.test/

✨

Set up for good. Herd starts automatically with your computer. From now on you simply open BankBird in your browser, even after a reboot. You'll only need Claude/Codex again for updates or troubleshooting.

🔒

Enable HTTPS (optional)

BankBird runs on HTTP by default — perfectly safe for local use

Want a green padlock? Run this once inside the project folder:

bash

herd secure

Follow the Windows prompt to trust Herd's local certificate (one UAC click). After that, https://bankbird.test works.

🛠

Advanced: manual installation

For developers or installs without Herd

Want to do every step yourself? After git clone:

bash

composer install
composer run setup
php artisan make:filament-user

Without Herd, start the dev server manually with composer run dev and open http://127.0.0.1:8000/. Note: you will need to start this server every time.

⚠️

Requirements without Herd: PHP 8.4 (8.5 not yet supported), Composer 2+, Node.js 20+, Git.

🔧

Common problems

Stuck? Start here

bankbird.test won't load

Check in the Herd app under "Sites" whether "bankbird" is listed as a parked site. If not, run inside the project folder: herd link bankbird.

Almost always a PHP version issue (PHP 8.5 instead of 8.4). Open Herd and set the PHP version for this site to 8.4. BankBird does not yet support PHP 8.5.

SSL error at https://bankbird.test

Run herd secure inside the project folder and confirm the Windows prompt to trust Herd's local certificate. Or just stick with HTTP — that's fine for local use.

"localhost" doesn't work (without Herd)

Use http://127.0.0.1:8000 instead of localhost. On Windows, localhost often resolves to IPv6, while php artisan serve only listens on IPv4.

"Class not found" or Vite error

Run composer dump-autoload and npm run build again. For persistent issues: php artisan optimize:clear.

💬

Still stuck? Open an issue on GitHub and we'll get you sorted quickly.