Getting Started

This section is the entry point for building a GoForj App.

Start here when you want to create a generated App, run it locally, and understand the files GoForj creates before moving into feature-specific guides.

Recommended Path

1. Quickstart creates, builds, runs, and verifies a local App.
2. Project Structure explains the generated 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. Starter Kits explains optional generated frontend scaffolds.

Next Practical Steps

• Local-First Development explains the local runtime loop after the first build.
• Runtime Observability shows how to prove an App workflow through metrics, inspects, Lighthouse, and logs.
• Commands explains generated App commands and custom command placement.

Related Sections

• Core Concepts explains the App, runtime lifecycle, providers, drivers, and generated components.
• Libraries documents the standalone Go packages that GoForj Apps compose underneath framework abstractions.