Home

Getting Started

Welcome to the laravel-app Wiki!
Follow the instructions bellow to get your application up and running.

Requirements

• Docker: Setting Up Docker on Ubuntu

Setting up the Environment

1. Build images

$ docker compose build

2. Run the containers

$ docker compose up -d

3. Finishing installation

$ chmod +x ./install.sh
$ ./install.sh

4. Access the application

http://localhost

Available Commands

❇️ Commands must run inside the container.

Command	Description
composer phpcs	Runs PHP_CodeSniffer phpcs to enforce PSR-12
composer phpcbf	Runs PHP_CodeSniffer phpcbf to fix code style errors
composer test	Runs all tests
composer test:coverage	Runs test coverage report
composer test:generate	Generates test coverage report
composer swagger:generate	Generates OpenAPI documentation
composer rector:dry-run	Rector will show you diff of files that it would change
composer rector:process	Rector will make the changes
php artisan top	Application monitoring

Included Packages

Name	Repository	Description
PHP CodeSniffer	squizlabs/php_codesniffer	Tokenizes PHP files and detects violations of a defined set of coding standards
PHPUnit	phpunit/phpunit	The PHP Unit Testing framework
Swagger PHP	zircote/swagger-php	A php swagger annotation and parsing library
Rector	rectorphp/rector	Instant Upgrades and Automated Refactoring of any PHP 5.3+ code
Laravel Top	leventcz/laravel-top	Real-time monitoring from the command line for Laravel applications