BoilerPlate

A base of Laravel, Vue.js and Docker with Sail using third-party libraries (prettier, pint, phpstan) to ensure good control of the CS and a CI prepared for use limiting the consumption of CI minutes and optimizing the use of cache.

Branche	Status	Coverage
Main
Develop

This is a Laravel 11.x app.

Requirements

• Unix distribution wsl2 for windows
• curl: apt install -y curl
• zip: apt install -y zip
• PHP >= 8.2 preferer la 8.3
• composer
• Make
• Docker

When copy the-BoilerPlate you need to :

1. Update the detail inside the security.txt located at public/.well-known
2. Create/Get the contact email for security, you can get an autonomous email from your repository on :

• Gitlab : Gitlab Service Desk Doc
  • Go to your Repository > Settings > General.
  • Locate the Service Desk section.
  • Enable it and copy the provided email - I know it's uggly, feel free to custom it like provided by Gitlab.

3. Generate an PGP key to encrypt all sensible data if anyone need to use your security contact:

• ssh-keygen -t rsa -b 4096 -C "PASTE_YOUR_EMAIL_CONTACT" -f ./public/.well-known/NAME_YOUR_KEY.
• ⚠️ Don't forget to copy the NAME_YOUR_KEY and NAME_YOUR_KEY.pub on an outside secured place and remove the NAME_YOUR_KEY.
• Update the security.txt, wiki etc. the the location and name of your PGP key.

How to run

1. Configure the local project with the provided git hooks:
   • Change the right of execute chmod +x ./.githooks/*
   • git config core.hooksPath ./.githooks
2. Set-up the project
   • make start to launch the project on your computer
   • make ssh to go inside the sail component
   • make design to execute the yarn dev and build on the fly the files
   • make stop Stop and clear the project

Run make or make help to see the list of possible commands.

Coding Style and Tests

You have to use coding rules on this projet, please use these commands to check or fix your code:

Check

• make ci Run the same as CI whith "check-files" then "tests"
• make checks-files Check the files with Pint, Prettier and PHPstan
• make phpstan Check the files with PHPstan
• make cs Check the files with Pint, Prettier

Fix

• make fix Fix all files with Pint and Prettier
• make fix-php Fix all files with Pint
• make fix-prettier Fix all files with Prettier

Tests

• make tests Run the PHPUnit
• make unit Run the PHPUnit

Update dependencies

Please keep in mind that these updates may break the build, so update them carefully and feel free to restart the front build at each update.

• make update Update the dependencies of node_modules and vendor

Do NOT update those dependencies

Things to keep in mind

• SASS : change the way to use the divid and the slash https://sass-lang.com/documentation/breaking-changes/slash-div

How to use

All the password of the seeded users was setted with the default password on config/variables/defaultPassword.