Laravel Dockyard : Laravel Dockerized Environment

This project provides a streamlined Docker-based development environment for Laravel using Docker. It includes setup scripts and handy Docker shortcut commands to simplify local development.

Prerequisites

Before you begin using this project, you need to ensure that your system meets the following preinstallation requirements:

• Docker & Docker Compose installed
• Bash shell available
• Git installed
• SSH access if cloning a private repository

1. Docker

This project relies on Docker to create and manage containers. You need to have Docker installed on your machine.

• Docker Engine: The core component for running containers.
• Docker Compose: Used to define and run multi-container Docker applications.

Installing Docker

You can download Docker based on your operating system:

• Docker for Mac
• Docker for Windows
• Docker for Linux

Verify Installation:

After installation, you can verify if Docker and Docker Compose are installed correctly by running:

docker --version
docker-compose --version

Note: Docker Desktop comes with Docker Compose preinstalled, so you don’t need to install it separately on macOS and Windows. On Linux, you might need to install it manually.

2. Docker Compose

This project uses Docker Compose to manage multiple Docker containers. You need to have Docker Compose installed on your machine.

Installing Docker Compose

You can download Docker Compose based on your operating system:

• Docker Compose for Mac
• Docker Compose for Windows
• Docker Compose for Linux

Verify Installation:

After installation, you can verify if Docker Compose is installed correctly by running:

docker-compose --version

3. System Requirements

• Linux: Any supported Linux distribution (e.g., Ubuntu).
• macOS: Docker Desktop for macOS.
• Windows: Docker Desktop for Windows, with WSL 2 enabled.

4. RAM and CPU

• A minimum of 4 GB of RAM is recommended.
• Docker uses CPU resources to manage containers, so ensure your machine has adequate resources.

Project Structure

├── README.md
├── ARCHITECTURE.md
├── SCRIPTS.md
├── cmd
│   ├── art
│   ├── artisan
│   ├── bash
│   ├── clear
│   ├── composer
│   ├── container
│   ├── down
│   ├── exec
│   ├── rebuild
│   ├── restart
│   ├── stop
│   ├── up
│   ├── workspace
├── Setup
│   ├── docker
│   │   ├── docker-compose.local.yml
│   │   ├── mysql
│   │   │   └── Dockerfile
│   │   ├── nginx
│   │   │   └── sites
│   │   │       └── web.local.conf
│   │   └── workspace
│   │       └── crontab
│   │           └── laradock
│   ├── install.sh
│   ├── swagger
│   │   └── swagger.yaml
│   └── utils.sh
└── Sources
    ├── public
    │   └── index.html
    └── web/app

Getting Started

1. Clone the repository:

git clone git@github.com:mzaman/laravel-dockyard.git laravel-dockyard

2. Navigate to the project directory:

cd laravel-dockyard

3. Environment Installation

Run the setup script:

chmod +x Setup/install.sh && ./Setup/install.sh

4. Edit the /etc/hosts file

sudo nano /etc/hosts

Add the following line:

127.0.0.1 web.test

This install.sh script will create a .env file with default values and set up the necessary Docker containers. The installation script will fully automate the setup process, including the configuration of all Docker services, installation of necessary dependencies, Laravel framework setup with specific configurations, database initialization, and seeding of initial data. With this single-step operation, everything will be up and running in just a few minutes. In most cases, you won’t need to manually verify or test any of the setup steps unless there are special circumstances that require attention.

Running the install.sh script multiple times consecutively poses no issues for the proposed project. Each execution will synchronize the necessary setup steps, securely skipping any previously completed processes. It will ensure that the setup progresses from the initial scratch state through the various build stages, ultimately reaching the live application status, even if some parts of the process have already been completed.

And this is the simple installation process — setting everything up effortlessly, so you can get started in no time!

Docker Shortcut Scripts

Script	Description	Example Usage
workspace	Enters workspace containers	./workspace
up	Starts Docker containers	./up
stop	Stops Docker containers	./stop
down	Stops and removes containers	./down
restart	Restarts containers	./restart
rebuild	Rebuilds containers with no cache	./rebuild
art	Runs Laravel Artisan in container	./art optimize:clear
artisan	Runs Laravel Artisan in container	./artisan optimize:clear

Make them executable:

chmod +x cmd/*

Other Example Usages

1. Enter cmd directory:

cd cmd

2. Run ./up to start the containers.

3. Run ./workspace to enter the workspace container where software is running.

4. Once inside the workspace container, enter cd /var/www/web or simply cd web to access the Laravel application. You can now run all Composer and Artisan commands.

Cache Clearing

./art optimize:clear

Install Composer dependencies

./composer install

Database Seeding

To populate the database with dummy data, run the following command from the cmd directory:

./art db:seed

Clearing Cached News

./clear

Please see the Scripts File for more information.

Docker yaml file location: Setup/docker/docker-compose.local.yml

Output

• Laravel code lives in: Sources/web
• Laradock lives in: Docker/

Web URLs:

• Frontend: http://web.test
• PhpMyAdmin: http://localhost:8081
• Host: mysql
• Username: root
• Password: root

Swagger test form: http://localhost:5555

Swagger source file location: Setup/swagger/swagger.yaml

Swagger Editor: http://localhost:5151

REDIS UI

URL: http://localhost:9987

• Username: laradock
• Password: laradock

License

MIT