Skip to content

docs(examples): clarify MongoDB prerequisites in Mongo-backed examples#15860

Merged
GermanJablo merged 4 commits into
mainfrom
issue-15857-custom-components-mongodb
Mar 9, 2026
Merged

docs(examples): clarify MongoDB prerequisites in Mongo-backed examples#15860
GermanJablo merged 4 commits into
mainfrom
issue-15857-custom-components-mongodb

Conversation

@GermanJablo
Copy link
Copy Markdown
Contributor

Summary

Clarifies local setup instructions so MongoDB-backed examples explicitly state that a running MongoDB instance is required before starting the app.

Closes #15857

Related

#15857

Changes

  • Adds explicit MongoDB prerequisite guidance to examples/custom-components Quick Start.
  • Applies the same guidance to other MongoDB-backed examples with missing setup notes (auth, custom-server, draft-preview, email, form-builder, live-preview, localization, tailwind-shadcn-ui, whitelabel).
  • Aligns example setup messaging more closely with template README conventions for local database prerequisites.

Testing

  • Not run (documentation-only changes).

Add explicit Quick Start guidance that the custom-components example requires a running MongoDB instance and where to configure DATABASE_URL, including authenticated connection strings.
Align MongoDB-backed example READMEs with template guidance by explicitly stating that a running MongoDB instance is required and that DATABASE_URL must point to it before starting local development.
Comment thread examples/auth/README.md Outdated
Comment thread examples/localization/README.md Outdated
Comment thread examples/tailwind-shadcn-ui/README.md Outdated
@PatrikKozak PatrikKozak self-assigned this Mar 6, 2026
@GermanJablo GermanJablo requested a review from PatrikKozak March 9, 2026 12:39
@GermanJablo GermanJablo merged commit 2aa973f into main Mar 9, 2026
16 checks passed
@GermanJablo GermanJablo deleted the issue-15857-custom-components-mongodb branch March 9, 2026 13:07
@github-actions
Copy link
Copy Markdown
Contributor

🚀 This is included in version v3.79.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

examples/custom-components: No mention of MongoDB requirement

3 participants