README

Linux for Composer

https://linuxforphp.net

Composer package that helps to easily configure and run Linux for PHP containers for any PHP project.

To install this library, please enter the following command:

composer require linuxforphp/linuxforcomposer

Once the dependencies are installed, you can create the linuxforcomposer.json file using:

php vendor/bin/linuxforcomposer.phar

NOTE: On Windows, please use the Linux for Composer PHAR file in the 'vendor/linuxforphp/linuxforcomposer/bin' folder.

Then, you only have to enter the following command to run the Linux for PHP containers that you have configured in the JSON file.

php vendor/bin/linuxforcomposer.phar docker:run start

If you wish to install the Linux for Composer binary for your entire system, please copy the PHAR file to a folder included in your PATH:

cp vendor/linuxforphp/linuxforcomposer/bin/linuxforcomposer.phar /usr/local/bin/linuxforcomposer

You will then be able to invoke the binary directly:

cd /folder/of/my/favorite/project
linuxforcomposer docker:run start

For more information on configuring and using Linux for Composer, please visit this page:

https://linuxforphp.net/documentation

Have a lot of fun! :)

PLEASE NOTE: As long as you have Docker, Composer, Git and cURL installed on your computer, this library should work fine. If on Windows, make sure you are using the linuxforcomposer.phar file contained in the 'vendor/linuxforphp/linuxforcomposer/bin' folder.

Enjoy!