Local Development

Installing

Prerequisites

Docker:

In order to follow the standard installation guide, you must have Docker installed.

Running Traefik Gateway:

We use Traefik to manage the networking configuration for the services. You can follow the installation instructions at Traefik Gateway.

Clone repository

The codebase is hosted on GitHub at github.com/fhict-skilltree/backend-application.

Clone the repository by running:

git clone git@github.com:fhict-skilltree/backend-application.git

Setup application

We have created a shell script to automate the building and installation process of the application. Run the following command in your terminal:

sh setup-dev.sh

This script will perform all the necessary steps to set up the application locally and make it ready for development.

The following things will be done automatically:

• Create .env if it does not exist yet
• Link the storage directory when you are installing it for the first time
• Run the database migrations
• Starts a shell session in the PHP application container

Running commands in the PHP service

If you want to execute scripts or run commands, you need to open up a shell process in the PHP container. You can do that as follows:

docker compose exec php sh

Code style

We’ve implemented a code style checker and fixer called Laravel Pint, which is a wrapper around PHP-CS-Fixer.

The following composer scripts can be run:

# To fix the codebase code style
composer run pint

# Fix code style on the changes you made
composer run pint-dirty

# Test the code style of the codebase
composer run pint-test

# Test the code style of the changes you made
composer run pint-test-dirty

Static code analyses (PHPStan)

We’ve implemented Larastan (PHPStan) to analyse our code statically. It will search for type errors in the codebase.

To run the static code analyses locally, you can run:

composer run analyse

To generate a new baseline, you can run:

composer run analyse-baseline