Installation

Clone the repository and set up the stack.

Clone and backend setup

git clone https://github.com/hojabbr/boilerplate.git
cd boilerplate
composer install
cp .env.example .env
php artisan key:generate

Edit .env: set APP_NAME, APP_URL, and DB_* at minimum. Optionally set MEILISEARCH_*, REVERB_*, etc. (see Configuration).

Frontend setup

npm install
npm run build

Database

php artisan migrate

Optional: php artisan db:seed to seed languages, settings, and optional content.

With Sail (Docker)

./vendor/bin/sail up -d
./vendor/bin/sail composer install
cp .env.example .env
./vendor/bin/sail artisan key:generate
# Edit .env as needed
./vendor/bin/sail npm install && ./vendor/bin/sail npm run build
./vendor/bin/sail artisan migrate

Next steps

  • Configuration — Environment variables and optional services (Meilisearch, Reverb, etc.).
  • Architecture — Boilerplate structure and conventions.

This site uses Just the Docs, a documentation theme for Jekyll.