Skip to content

[Feature] Docs: Add windows setup guide and docker compose details #242

@Harshit28j

Description

@Harshit28j

Is your feature request related to a problem?

The docs mention make dev-up but:

  • make doesn't work on Windows by default
  • No explanation of what docker-compose services are started
  • No database credentials or ports documented

This creates friction for Windows contributors trying to set up the dev environment.

The Solution

Add to CONTRIBUTING.md:

  1. How windows users can run commands (via wsl or direct docker commands)
  2. List of services, ports, and default credentials
  3. Alternative commands for users without make

Example to add:

# Windows users without make can run:
docker compose up -d --build   # instead of make dev-up
docker compose down            # instead of make dev-down

Alternatives Considered

Windows users could install make via Chocolatey or Scoop, but this adds extra setup steps. Documenting the direct docker commands is simpler.

Affected Components

Documentation

Participation

  • I am willing to submit a pull request for this feature.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions