Giter Club home page Giter Club logo

compose's Introduction

Compose for Laravel

compose-for-laravel

This package is in development and not yet ready for production use.

Introduction

Compose for Laravel is a package that simplifies running and deploying Laravel applications using Docker Compose. It supports macOS, Linux, and Windows (WSL2). This package leverages Docker Compose for container orchestration and Traefik for routing HTTP requests.

Installation

To install Compose for Laravel, include it in your Laravel application's composer.json file:

composer require --dev braceyourself/compose

Upon installation, the compose script will be available in vendor/bin. Run the install command to set up node_modules and composer dependencies.

./vendor/bin/compose install

Usage

Available Commands

compose COMMAND [options] [arguments]
  • compose install: Build the Docker containers
  • compose build: Build the Docker containers
  • compose start: Start the application
  • compose deploy: Deploy the application to a remote server

All other commands are passed to docker compose or artisan

You can always use docker compose directly after running compose the first time.

After running compose for the first time, the docker-compose file will be published to your project root.

Environment Variables

Ensure you have a .env file in your project root. The script will source this file to set up the necessary environment variables.

When running the deploy command, the remote .env file will be created based on your .env.example file

Troubleshooting

If you encounter issues, ensure your system meets the requirements and that Docker and Docker Compose are properly installed and configured.

Please report any issues.

compose's People

Contributors

braceyourself avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.