Skip to content
Getting started

Installation

Install BaPlay locally or in GitHub Codespaces with the required PHP and Node tooling.

Runtime requirements

  • PHP 8.2+; PHP 8.3 recommended
  • Composer 2
  • Node.js 22+ and npm 10+
  • SQLite, MySQL 8, or MariaDB 10.6+

Required PHP extensions are checked by scripts/check-extensions.php. The Codespaces and Docker images install them automatically.

Environment and storage

cp .env.example .env
php artisan key:generate
php artisan storage:link
php artisan migrate --force

Use an absolute SQLite database path when the process working directory may differ. Production should configure Redis or database queues, a real mail transport, trusted reverse proxies, and Stripe values only when billing is enabled.

Production optimization

composer install --no-dev --optimize-autoloader
npm ci && npm run build
php artisan config:cache
php artisan route:cache
php artisan view:cache

Run queue workers continuously and execute php artisan schedule:run every minute. Never commit .env, generated credentials, source URLs containing secrets, or runtime cache data.