Skip to content

doc: update Docker commands and application URL in contributing guide#356

Merged
calvadev merged 2 commits intoshopstr-eng:mainfrom
wolgwang1729:doc
Apr 6, 2026
Merged

doc: update Docker commands and application URL in contributing guide#356
calvadev merged 2 commits intoshopstr-eng:mainfrom
wolgwang1729:doc

Conversation

@wolgwang1729
Copy link
Copy Markdown
Contributor

Description

  • Updated Docker Compose commands in contributing.md from deprecated docker-compose to modern docker compose syntax:
    • docker compose up -d
    • docker compose down
    • docker compose down -v
  • Updated local development URL references from http://localhost:3000 to http://localhost:5000 to match the project dev script (next dev -p 5000).
  • Improved environment setup instructions by adding a template-based flow:
    • Added cp env.example .env as the primary setup path.
    • Kept manual .env creation instructions as a fallback.

Impact:

  • Prevents zsh: command not found: docker-compose errors for contributors using newer Docker installations.
  • Aligns docs with the actual runtime port, reducing onboarding confusion.
  • Makes initial setup faster and less error-prone by encouraging use of env.example.

Resolved or fixed issue

none

Screenshots (if applicable)

N/A (documentation-only change; no UI updates)

Affirmation

Copilot AI review requested due to automatic review settings April 6, 2026 08:10
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 6, 2026

@wolgwang1729 is attempting to deploy a commit to the shopstr-eng Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the contributing guide to reflect current Docker Compose CLI usage and the app’s actual local development URL/port, while streamlining environment setup.

Changes:

  • Replaced deprecated docker-compose commands with docker compose.
  • Updated localhost URL references from port 3000 to 5000.
  • Added a template-based .env setup path (cp env.example .env) with a manual fallback.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@calvadev calvadev merged commit 4961c6f into shopstr-eng:main Apr 6, 2026
1 check failed
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.

3 participants