Chapter 3

The Convention Surface

The naming, structure, and response patterns Grit assumes — saving you decision fatigue.

~24 min total4 lessonsAssignment

By the end of this chapter you'll be able to

Predict where a file should live before you create it
Name things the way Grit expects (and why)
Read any Grit API response without looking up the shape

Lessons

Module: How files are organized

Folder conventions

internal/, packages/shared, apps/ — the rules and the rationale.

7measy

Naming conventions

snake_case Go, kebab-case TS, plural routes, plural tables.

5measy

Module: How data flows

The API response envelope

{ data, message } / { data, meta } / { error } — and HTTP status codes.

6measy

Error handling

Go: explicit + wrapped. React: error boundary + toast.

6mmedium

Chapter assignment

Add a field to the User model

Add a `bio` (string, nullable) field to the User model. Run the migration. Update the seeder. Verify it appears in the API response. Commit the change with a conventional commit message.

See success criteria

Lesson 1 takes ~7 min.

Start chapter

Spot a typo? Have an idea?

Help us improve this chapter. One click opens a GitHub issue with this chapter's URL pre-filled — suggest a clearer wording, report a bug, or request a new lesson. The course keeps improving thanks to learners like you.

Suggest an improvement on GitHub

ch.2: Your First Grit Project ch.4: Code Generation & Type Sync