Skip to content

docs: Rework the Build your first app guide for 3.5#557

Merged
developerjamiu merged 6 commits into
mainfrom
docs/first-app-3-5-rework
May 29, 2026
Merged

docs: Rework the Build your first app guide for 3.5#557
developerjamiu merged 6 commits into
mainfrom
docs/first-app-3-5-rework

Conversation

@developerjamiu
Copy link
Copy Markdown
Contributor

@developerjamiu developerjamiu commented May 27, 2026

Reworks the "Build your first app" tutorial (the magic recipe app) for Serverpod 3.5, per #545.

What changed across the four pages:

  • Replaces docker compose + dart bin/main.dart + manual serverpod generate with serverpod start (watch mode, hot reload, embedded Postgres). The app starts once on page 1 and hot reloads through the rest.
  • Matches the actual beta.9 project template (the screens/ layout and pre-wired client) instead of the stale code snippets.
  • Migrations are created and applied from the serverpod start TUI (the M and A keys).
  • Page 4 becomes "Deploy your app", defaulting to Serverpod Cloud, with the old summary folded in as "What you've built".
  • Adds title and description frontmatter, plus "Before you start" and continuation intros, per the tutorial template.

Note: the upstream magic_recipe example repo that feeds the SNIPSTART snippets is stale for beta.9. This PR inlines correct code; the example repo still needs a separate update.

Closes #545

@developerjamiu developerjamiu requested a review from Swiftaxe May 27, 2026 15:38
@developerjamiu developerjamiu added documentation Improvements or additions to documentation enhancement New feature or request labels May 27, 2026
@developerjamiu developerjamiu self-assigned this May 27, 2026
Copy link
Copy Markdown
Collaborator

@Swiftaxe Swiftaxe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, a massive improvement of this guide! I added some comments to polish some details even further.

Comment thread docs/05-build-your-first-app/04-deployment.md Outdated
Comment thread docs/05-build-your-first-app/03-working-with-the-database.md
Comment thread docs/05-build-your-first-app/03-working-with-the-database.md
Comment thread docs/05-build-your-first-app/01-creating-endpoints.md Outdated
Comment thread docs/05-build-your-first-app/01-creating-endpoints.md Outdated
Comment thread docs/05-build-your-first-app/04-deployment.md Outdated
Comment thread docs/05-build-your-first-app/01-creating-endpoints.md Outdated
Comment thread docs/05-build-your-first-app/02-models-and-data.md Outdated
Comment thread docs/05-build-your-first-app/01-creating-endpoints.md
Comment thread docs/05-build-your-first-app/03-working-with-the-database.md Outdated
Comment thread static/img/getting-started/tui-logs.png
Comment thread docs/05-build-your-first-app/01-creating-endpoints.md Outdated
Comment thread docs/05-build-your-first-app/02-models-and-data.md Outdated
Comment thread docs/05-build-your-first-app/02-models-and-data.md
Comment thread docs/05-build-your-first-app/03-working-with-the-database.md Outdated
@developerjamiu developerjamiu requested a review from Swiftaxe May 29, 2026 14:36
Copy link
Copy Markdown
Collaborator

@Swiftaxe Swiftaxe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@developerjamiu developerjamiu merged commit c9cd420 into main May 29, 2026
4 checks passed
@developerjamiu developerjamiu deleted the docs/first-app-3-5-rework branch May 29, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update the guide "Build your first app" for 3.5

2 participants