/ovh.arthaud.yaki

Primary LanguagePHP

Personal template for Laravel

Requirements

  • Docker

What's included

  • Reduced Sail Laravel 9. (only mysql and mailhog containers)
  • Laravel livewire
  • Breeze auth & tailwind & alpinejs starter kit
  • Larastan (static code analysis)
  • Github CI setup on develop branch for auto deployment with a webhook (host agnostic)

Setup & use

Local setup

cp .env.sail.example .env

Then setup your local env, and do following commands :

composer install
sail up -d
sail artisan key:generate
sail artisan migrate
sail npm i

Local use when developing

Start sail

sail up -d

And run vite in dev mode

sail npm run dev

Github CI setup

The following setup is for a staging environment, you can adapt it by modifying .github/workflows files too.
By default, CI workflow will start for every commit on develop branch.
It will build js/css bundle with a github action and push it to the release/staging branch.
Then, the deployment script, called by the webook, will pull on this branch.

  • Go to the "Settings" tab of your repo, then go to "Secret and variables" > "Actions".
  • Add new repository secret, name it STAGING_WEBHOOK_SECRET and put a personalized token. It should be the same that your env variable WEBHOOK_SECRET in .env file
  • Add another secret, name it STAGING_WEBHOOK_URL and put your website url with https scheme, and without trailing slash (ex: https://example.com)

Then, you should authorize github actions to push to your repo :

  • Go to the "Settings" tab of your repo, then go to "Actions" > "General".
  • Check "Read and write permissions" at "Workflow permissions" section

Server setup without docker

On your server, you will need git and composer. Clone your repository, cd into and

cp .env.example .env

Then setup your env, and do following commands :

composer install
php artisan key:generate
php artisan migrate