Installation

Installation

Follow this sequence on a fresh clone.

1. Install dependencies

composer install
npm install

2. Create your environment file

cp .env.example .env

At minimum, set APP_URL, DB_HOST, DB_PORT, DB_DATABASE, DB_USERNAME, and DB_PASSWORD.

3. Run migrations

php database/migrate.php

This command creates the database when needed and applies pending SQL files from database/migrations/.

Configure auth and feature toggles

AUTH_METHOD=both
MAIL_MAILER=smtp
# or
MAIL_MAILER=log

MULTI_TENANCY_ENABLED=false

STRIPE_SECRET_KEY=
STRIPE_PUBLISHABLE_KEY=
STRIPE_WEBHOOK_SECRET=
STRIPE_PRICE_PRO_MONTHLY=

AUTH_METHOD supports otp, magic_link, and both.

Start the frontend pipeline

npm run dev

XAMPP + keel.local setup

  1. Place the project at C:\xampp\htdocs\keel.
  2. Add 127.0.0.1 keel.local to your hosts file.
  3. Add a vhost pointing DocumentRoot to C:/xampp/htdocs/keel/public_html.
  4. Ensure Apache loads httpd-vhosts.conf and restart Apache.
  5. Set APP_URL=http://keel.local.

Optional Docker Compose path

docker compose up --build
docker compose exec app composer install
docker compose exec app npm install
docker compose exec app php database/migrate.php

Then open http://localhost:8080.