Question 1

How to use project-layout for a Go microservice?

Accepted Answer

Start by cloning the repository and focusing on key directories: use /cmd for your main application, /internal for business logic, and /api for OpenAPI specs. Tailor it by removing unused directories to keep it minimal for your service needs.

Question 2

Project-layout vs official Go module layout: what's the difference?

Accepted Answer

The official Go module layout is minimal and focuses on module mechanics like go.mod, while project-layout provides a comprehensive structure for application organization. Use project-layout for larger, team-based projects, but always cross-reference with official docs for module-specific rules.

Question 3

When should I use /internal instead of /pkg in my Go project?

Accepted Answer

Use /internal for code that should not be imported by external projects, as it's enforced by the Go compiler. Use /pkg for public, reusable libraries that you want others to depend on, ensuring they are stable and well-documented.

Question 4

Does project-layout work with Go modules?

Accepted Answer

Yes, it's fully compatible with Go modules; the README mentions using Go Modules for dependency management and provides guidance on the /vendor directory for vendoring if needed, especially with older Go versions.

Question 5

What are the main criticisms of the project-layout repository?

Accepted Answer

Critics argue it can be too prescriptive for small teams, and some directories like /pkg are optional and debated. It's also not an official standard, so developers must evaluate its fit rather than blindly following it.

Question 6

Can I use project-layout for a web app with a frontend?

Accepted Answer

Yes, it includes a /web directory for static assets, server-side templates, and SPAs, as described in the README. You can place frontend files there and integrate with your Go backend code in other directories.

project-layout

What is project-layout?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions