README.md

Laravel package

This is a Kurtosis Laravel package you can use as a template to create your own Laravel project.

This package uses the PHP-FPM technology to run the PHP code (the Laravel app in this case) and the webserver (Nginx in this case) in different containers to increase efficiency and performance.

How to run this Laravel example package?

In Kurtosis cloud

You can run this package very easily from the Kurtosis cloud

Step 1

Login into the Kurtosis cloud

Step 2

Find the package in the catalog and press the run button

This screen record shows the entire run workflow:

Using the Kurtosis CLI

You can run this package also with the Kurtosis CLI.

Step 1

Install Kurtosis

Step 2

Create the package's configuration file to set your custom values to run the package.

Duplicate the example-config.yml file and rename it to config.yml.

# in the package's root
cp ./example-config.yml ./config.yml

Fill the created config.yml file with your custom values.

Make sure to not commit or include this file in the repository history (for serurity reasons dude it contains private credentials), you can check that the config.yml was added into the .gitignore file.

Step 3

Use the run command to execute the package:

kurtosis run github.com/kurtosis-tech/laravel-package --args-file config.yml

To blow away the created enclave, run kurtosis clean -a.

Step 4

You can access to the application in the browser by clicking or copying the nginx address printed at the end of the package execution, in the Ports colum inside the User Services section

How to create your own Laravel application based on this package?

STEP 1

Click "Use this template" to generate a new repository based on this one. Then open your terminal and clone your repository:

# replace YOURUSER and YOURREPO with the correct values
cd ~/Desktop
git clone https://github.com/[YOURUSER]/[YOURREPO].git

STEP 2

Create your own Laravel application

You can edit the Laravel app by editing the files inside the ./laravel-app/files/ folder.