Getting Started

This section takes you from an empty directory to a running Go application.

Start here to create a project, run it locally, and learn where routes, services, configuration, and dependency wiring belong.

Recommended Path

1. Quickstart creates, builds, runs, and verifies a local app.
2. Project Structure explains the directory layout and ownership boundaries.
3. Configuration explains .goforj.yml, environment files, and driver selection.
4. JSON API Route walks through a first route, controller, service, Wire provider, and test.
5. Runnable Scenarios continue through cache, storage, events, jobs, schedules, and observability.
6. Choose a Starter Kit explains the optional frontend code created with a project.

Next Practical Steps

• Local-First Development explains the local runtime loop after the first build.
• Runtime Observability shows how to verify a workflow through metrics, inspects, Lighthouse, and logs.
• Commands explains app commands and where custom commands belong.

Related Sections

• Core Concepts explains apps, runtime lifecycle, providers, drivers, and code ownership.
• Libraries documents the standalone Go packages used by the framework.