Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Docker Setup Instructions and Automation Script #99

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

Higor-Matos
Copy link

Summary

This pull request adds Docker setup instructions and an automation script to the Laravel Gymie project. The following changes have been made:

  • README.md:

    • Added a new section with detailed instructions on how to set up and run the project using Docker.
    • Included a subsection outlining the particularities for Docker, specifically mentioning the use of Nginx as a reverse proxy due to compatibility issues with the PHP version.
    • Provided instructions for using the setup script setup_gymie_docker.sh to automate the Docker setup process.
  • Setup Script:

    • Added setup_gymie_docker.sh, a script to automate the Docker setup process. This script builds and starts the Docker containers, waits for MySQL to be ready, sets up the necessary directories and permissions, installs dependencies, sets up environment variables, generates the application key, runs migrations, and sets permissions inside the container.

Detailed Changes

README.md

  • Added Docker Method section under Installation:
    • Step-by-step instructions to set up the project using Docker.
    • Specifics on using Nginx as a reverse proxy due to PHP version compatibility issues.
    • Instructions for using the setup_gymie_docker.sh script for automated setup.

setup_gymie_docker.sh

  • Automates the following steps:
    • Building and starting Docker containers.
    • Waiting for MySQL to be ready.
    • Setting up necessary directories and permissions.
    • Installing composer dependencies.
    • Setting up environment variables.
    • Generating application key.
    • Running migrations and seeding the database.
    • Modifying php-fpm listen directive.
    • Restarting php-fpm.
    • Adding a cron job for scheduled tasks.

Testing

Tested the Docker setup and script on a local environment to ensure all services start correctly and the application is accessible through Nginx.

Notes

These additions aim to simplify the setup process for new users and contributors by providing a standardized Docker environment.

Thank you for considering this pull request. Please let me know if there are any changes or additional improvements required.

@Higor-Matos
Copy link
Author

Hi @ajitbohra

I have added Docker setup instructions and an automation script as outlined in the description. Please review the changes at your earliest convenience. If there are any adjustments needed or questions, feel free to let me know.

Thank you for your time and consideration.

Best regards,
Higor Matos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant