Docs Getting Started

Getting Started

This section helps you go from zero to a running Plumego service
with the smallest possible mental and technical overhead.

It does not try to teach everything.
It focuses on what you must understand first.


Who This Section Is For

This section assumes that you:

  • Are comfortable with Go
  • Understand basic HTTP concepts
  • Want to see real code early
  • Prefer explicit setup over magic

If you are completely new to Go or HTTP,
you may want to review those fundamentals first.


What You Will Learn Here

By the end of this section, you will:

  • Install Plumego
  • Run a minimal HTTP server
  • Understand the basic project layout
  • Handle your first request
  • See how explicit wiring works in practice

You will not learn advanced patterns here.
Those belong in later sections.


How This Section Is Structured

This section is intentionally linear.
It is recommended to read pages in order.

1. Installation

Learn how to install Plumego and set up a minimal Go module.

No generators.
No scaffolding tools.
Just Go.


2. Minimal Server

Run the smallest possible Plumego application.

This example demonstrates:

  • Application construction
  • Router setup
  • Middleware registration
  • Server startup

Nothing more.


3. Project Layout

Understand a recommended but non-mandatory project structure.

This layout:

  • Scales from small to large systems
  • Keeps boundaries explicit
  • Avoids framework lock-in

You are free to adapt it — deliberately.


4. First Request

Handle your first HTTP request end-to-end.

This includes:

  • Routing
  • Handler execution
  • Response writing
  • Error handling basics

This is where the execution model becomes concrete.


What This Section Intentionally Avoids

This section does not cover:

  • Authentication
  • Authorization
  • Databases
  • Background jobs
  • WebSockets
  • Validation
  • Observability
  • Advanced configuration

These topics are covered later,
once the fundamentals are clear.


A Note on Explicitness

You may notice that Plumego requires more setup
than some other frameworks.

This is intentional.

The goal of this section is not speed,
but understanding what happens and why.

Every line of code you write here
will matter later.


After Getting Started

Once you complete this section, the recommended next steps are:

  • Concepts — understand core mental models
  • Architecture — learn the structural constraints
  • Guides — apply Plumego to real problems

Skipping directly to advanced topics is discouraged.


Summary

Getting started with Plumego means:

  • Writing real code
  • Making explicit decisions
  • Understanding control flow early

This section gives you a stable foundation.

Everything else builds on it.


Next Pages

  • Installation
  • Minimal Server
  • Project Layout
  • First Request

Take your time here.
Clarity at the beginning saves effort later.

In this section

  • Installation
    How to install Plumego and set up a Go development environment with minimal assumptions.
  • Minimal Server
    The smallest possible Plumego server that can accept and respond to an HTTP request.
  • Project Layout
    A simple, evolvable project structure for Plumego applications, designed to stay readable as systems grow.
  • Your First Request
    Understanding how a single HTTP request flows through a Plumego application, from arrival to response.