php - How to setup and run laravel, from git?

Solution:

For those struggling with this issue... I've found a command that work perfectly fine.

First of all, you don't need to locally have any PHP or Composer installed, maybe there is a misunderstanding about it, all you need is Docker.

Docker will install everything you need in something I understand is like a sandbox, not locally, for each project.

And for those downloaded projects, from GIT as example, that does not havevendor folder, and obviously cannot executesail up you can simple execute:

docker run --rm --interactive --tty -v $(pwd):/app composer install
Copy code

That command will download a composer image for docker, if you do not have one yet. Then, will run acomposer install and you are free to execute a./vendor/bin/sail up if you hadn't configured an alias or justsail up if you already configure an alias.

That's all.

Solution:

The official documentation lists the following command.

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v $(pwd):/var/www/html \
    -w /var/www/html \
    laravelsail/php81-composer:latest \
    composer install --ignore-platform-reqs
Copy code

If you were to clone a Laravel project and run this command in the project root, it would create a very small container with php and composer installed and run composer in the project root to install all php dependencies. In effect, this installs the Laravel core code into the cloned project. Once the project in set up this way, the user should create a local.env file to match their development evironment.

cp .env.example .env            # creates a .env file to be populated for the local environment
Copy code

With the envronment set up, they can now create the application containers in docker and run the application. Laravel provides the Sail helper for this.

./vendor/bin/sail up -d         # runs the docker containers in detached mode
Copy code

Now it's a matter of setting up the laravel app and running the Laravel app. (I'm assuming the app uses one of the Laravel start kits that rely on Node.js. If you are using a Blade only application, you can skip the "npm" commands.)

sail artisan key:generate       # (Best Practice) Generate a new application key on each machine
sail artisan migrate            # Scaffold the database structure
sail artisan db:seed            # (Optional) Seed the database with data
sail npm install                # (Optional) Install front-end dependencies (Inertia, Vue, React, others...)
sail npm run dev                # (Optional) Run the front-end framework in development mode
Copy code

With this, the new developer should be running an exact copy of both the project and the development environment as the original developer.

Your project README may include additional steps to set up some other dependencies, but this is the basic workflow for contributing to a Laravel project.

The only prerequisites for this workflow is to have Docker installed with an Internet connection. This is most easily accomplished on Windows, Mac, and Linux by installing Docker Desktop.

Alternate for Older Projects

If you are working on an older project that doesn't use Laravel Sail, but does have adocker-compose.yml file, you should be able to build and run the necessary containers with the following command.

docker-compose up --build -d
Copy code

Once you have the containers running, you would need to install the project dependencies directly into the container.

docker ps             # find the container ID of your project's container
docker exec -it CONTAINER_ID php artisan key:generate
docker exec -it CONTAINER_ID php artisan migrate
docker exec -it CONTAINER_ID php artisan db:seed
docker exec -it CONTAINER_ID npm install
docker exec -it CONTAINER_ID npm run dev
Copy code

Of course, Docker Desktop simplifies this process. With a button click you can have a terminal shell open directly in your container eliminating the need for thedocker exec command.