Laravel + Docker guide #21276

rw4lll · 2024-10-29T22:42:15Z

Description

Introduces new section /frameworks and adds first guide for Laravel PHP framework based on Docker Compose with examples for development and production environments.

Additionally (a topic to discuss) introduces boolean flag "external" for sidebar links to improve the user experience, when dealing with external links to open them in a new tab.

Related issues or tickets

Closes Laravel + Docker guide #21268

Reviews

Technical review
Editorial review
Product review

netlify · 2024-10-29T22:42:31Z

✅ Deploy Preview for docsdocker ready!

Name	Link
🔨 Latest commit	`eec526c`
🔍 Latest deploy log	https://app.netlify.com/sites/docsdocker/deploys/672922eb17e19c00087afa48
😎 Deploy Preview	https://deploy-preview-21276--docsdocker.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

dvdksn

Thanks a lot @rw4lll

Is this PR ready for review yet? 🔍

content/guides/frameworks/laravel/development-setup.md

content/guides/frameworks/laravel/production-setup.md

content/guides/frameworks/laravel/development-setup.md

content/guides/frameworks/laravel/production-setup.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

rw4lll · 2024-10-30T19:06:47Z

Thanks a lot @rw4lll

Is this PR ready for review yet? 🔍

I hope so 😄 . I've tried to add tags, but it seems that if add a new tag, its not recognized:

tags: [frameworks]
languages: [php]

This will return error like:

2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/_index.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/_index.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/common-questions.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/prerequisites.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/production-setup.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/development-setup.md
2024-10-30 20:00:25 Built in 4527 ms
2024-10-30 20:00:25 Error: error building site: logged 6 error(s)

But if I use any other tag which already exists, it works well. Where can I register new "frameworks" tag or should I use one existing?

rw4lll · 2024-10-31T18:23:40Z

@dvdksn added tag support

dvdksn · 2024-11-04T12:31:56Z

layouts/partials/sidebar/guides.html

@@ -35,7 +35,7 @@
    <p>Resources:</p>
    <ul class="ml-4 space-y-2">
      {{- range . }}
-        <li><a href="{{ .url }}" class="link">{{ .title }}</a></li>
+        <li><a href="{{ .url }}" {{- if .external }} target="_blank" {{- end }} class="link">{{ .title }}</a></li>


Let's remove this and the corresponding front matter property; last week I'd said LGTM but I was recently made aware that target=_blank is a bad pattern. See this issue:

Please remove target="_blank" on links #21291

Sure, fixed

content/guides/frameworks/laravel/_index.md

content/guides/frameworks/laravel/prerequisites.md

dvdksn · 2024-11-04T13:27:59Z

content/guides/frameworks/laravel/development-setup.md

+# Install NVM (Node Version Manager) as the www user
+RUN export NVM_DIR="$HOME/.nvm" && \
+    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash && \
+    [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh" && \
+    nvm install ${NODE_VERSION} && \
+    nvm alias default ${NODE_VERSION} && \
+    nvm use default
+
+# Ensure NVM is available for all future shells
+RUN echo 'export NVM_DIR="$HOME/.nvm"' >> /home/www/.bashrc && \
+    echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"' >> /home/www/.bashrc && \
+    echo '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"' >> /home/www/.bashrc


Can you explain why you're using NVM here?

@dvdksn sure, the idea is to use this container as a workspace for laravel local development. It should include at least php cli for running artisan commands and node for assets building. Nvm here helps to switch between node versions easily through the env param.

dvdksn · 2024-11-04T13:30:37Z

content/guides/frameworks/laravel/development-setup.md

+        UID: ${UID}
+        GID: ${GID}


If GID and UID env vars are unset, this would set UID and GID to empty strings, and thereby override the default 1000 set in the Dockerfile

dvdksn · 2024-11-04T13:33:18Z

content/guides/frameworks/laravel/development-setup.md

+      - "${POSTGRES_PORT}:5432"
+    environment:
+      - POSTGRES_DB=${POSTGRES_DATABASE}
+      - POSTGRES_USER=${POSTGRES_USERNAME}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}


This compose file has a lot of dependencies to environment variables. I think it's better to try and keep non-secret values in the compose file directly. Still, the .env will need some explanation.

content/guides/frameworks/laravel/development-setup.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

rw4lll added 4 commits October 29, 2024 19:34

Add initial laravel example pages

0ae8bd3

Added external link support for resource links in the sidebar

9098194

fixes and improvements

2d069c6

fixes and improvements

71a1eb2

github-actions bot added hugo Updates related to hugo area/guides labels Oct 29, 2024

dvdksn reviewed Oct 30, 2024

View reviewed changes

rw4lll and others added 6 commits October 30, 2024 19:03

Update content/guides/frameworks/laravel/development-setup.md

a5a7c1f

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/production-setup.md

a9870a2

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/development-setup.md

57f7655

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/production-setup.md

dd9102e

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/production-setup.md

d2713be

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Merge branch 'main' into laravel-compose

c13166e

added tag support

5f5c0c3

rw4lll requested a review from dvdksn October 31, 2024 18:23

dvdksn reviewed Nov 4, 2024

View reviewed changes

rw4lll and others added 11 commits November 4, 2024 19:48

Update content/guides/frameworks/laravel/development-setup.md

09f3333

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/_index.md

06a6a70

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/_index.md

ac5281c

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/prerequisites.md

665fc3a

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/prerequisites.md

b2e3e8c

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/prerequisites.md

10b1359

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/prerequisites.md

85aba4d

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/prerequisites.md

b151dce

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Update content/guides/frameworks/laravel/production-setup.md

97cf0f1

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Apply suggestions from code review

eaac035

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

remove compose-lp-survey-anchor tag, adjust newlines

ed71738

rw4lll and others added 2 commits November 4, 2024 20:23

remove external link property

8e48d11

Update content/guides/frameworks/laravel/prerequisites.md

eec526c

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Laravel + Docker guide #21276

Laravel + Docker guide #21276

rw4lll commented Oct 29, 2024 •

edited by dvdksn

Loading

netlify bot commented Oct 29, 2024 •

edited

Loading

dvdksn left a comment

rw4lll commented Oct 30, 2024

rw4lll commented Oct 31, 2024

dvdksn Nov 4, 2024

rw4lll Nov 4, 2024

dvdksn Nov 4, 2024

rw4lll Nov 4, 2024

dvdksn Nov 4, 2024

dvdksn Nov 4, 2024

Laravel + Docker guide #21276

Are you sure you want to change the base?

Laravel + Docker guide #21276

Conversation

rw4lll commented Oct 29, 2024 • edited by dvdksn Loading

Description

Related issues or tickets

Reviews

netlify bot commented Oct 29, 2024 • edited Loading

✅ Deploy Preview for docsdocker ready!

dvdksn left a comment

Choose a reason for hiding this comment

rw4lll commented Oct 30, 2024

rw4lll commented Oct 31, 2024

dvdksn Nov 4, 2024

Choose a reason for hiding this comment

rw4lll Nov 4, 2024

Choose a reason for hiding this comment

dvdksn Nov 4, 2024

Choose a reason for hiding this comment

rw4lll Nov 4, 2024

Choose a reason for hiding this comment

dvdksn Nov 4, 2024

Choose a reason for hiding this comment

dvdksn Nov 4, 2024

Choose a reason for hiding this comment

rw4lll commented Oct 29, 2024 •

edited by dvdksn

Loading

netlify bot commented Oct 29, 2024 •

edited

Loading