Skip to main content

Quick Start

Get your Macuin Laravel e-commerce platform up and running in just a few minutes using Docker.
This guide assumes you have Docker and Docker Compose installed on your system. If not, see the Installation guide for detailed setup instructions.

Prerequisites

Before you begin, ensure you have the following installed:
  • Docker Desktop or Docker Engine
  • Docker Compose
  • Git

Launch Your Instance

1

Clone the Repository

Clone the Macuin Laravel repository to your local machine:
git clone https://github.com/benjamin10x/macuin-laravel.git
cd macuin-laravel
2

Start Docker Containers

Build and start all services using Docker Compose:
docker compose up -d --build
This command will:
  • Build the Laravel application container
  • Pull required images (Nginx, PostgreSQL, Node.js)
  • Start all services in detached mode
  • Set up the network and volumes
3

Install Dependencies & Configure

Access the Laravel container and set up the application:
# Enter the container
docker exec -it laravel_app bash

# Inside the container, run:
composer install
cp .env.example .env
php artisan key:generate
php artisan migrate
Exit the container when done:
exit
4

Access the Application

Your Macuin Laravel instance is now running! Open your browser and navigate to:
http://localhost:8000
You should see the Macuin homepage with product categories and featured items.

What’s Running?

After completing the setup, you’ll have four Docker containers running:

Nginx

Web server on port 8000

Laravel App

PHP 8.3 application server

PostgreSQL

Database server on port 5432

Node.js

Asset compilation on port 5173

Verify Installation

Test your installation by exploring these features:
  1. Homepage - View product categories and featured items
  2. Catalog - Browse the product catalog at http://localhost:8000/catalogo
  3. Authentication - Access login at http://localhost:8000/login

Useful Commands

docker compose down

Next Steps

Full Installation Guide

Detailed configuration options

Docker Configuration

Customize your Docker setup

Features Overview

Explore platform capabilities

Troubleshooting

Change the Nginx port in docker-compose.yml:
nginx:
  ports:
    - "8080:80"  # Change 8000 to 8080 or another available port
Ensure PostgreSQL is fully started. Check health status:
docker ps
Look for “healthy” status on the laravel_postgres container.
The PHP container runs as user 1000:1000. Ensure your local user has appropriate permissions, or adjust UID/GID in docker-compose.yml.

Build docs developers (and LLMs) love