8000 docs: Add Expo quick start guide by dshukertjr · Pull Request #40744 · supabase/supabase · GitHub
[go: up one dir, main page]
Skip to content

docs: Add Expo quick start guide #40744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
dshukertjr merged 4 commits into from
Dec 16, 2025
Merged

docs: Add Expo quick start guide #40744

dshukertjr merged 4 commits into from
Dec 16, 2025

Conversation

@dshukertjr
Copy link
Member
@dshukertjr dshukertjr commented Nov 24, 2025 •
edited by coderabbitai bot
Loading

I have read the CONTRIBUTING.md file.

YES

What kind of change does this PR introduce?

We have most of the major frameworks that we support, but we are missing Expo. In my opinion, Expo is an important one that we should have covered. This PR adds it.

Summary by CodeRabbit

  • New Features

    • Expo React Native quickstart added to the Getting Started navigation.

  • Documentation

    • New step-by-step guide for Supabase with Expo React Native: project creation, dependency installation, environment setup, client initialization, example app showing data fetching, and next-step links.

  • Chores

    • Removed an obsolete global type reference from the docs environment configuration.

✏️ Tip: You can customize this high-level summary in your review settings.

@supabase
Copy link
supabase bot commented Nov 24, 2025

This pull request has been ignored for the connected project xguihxuzqibwxjnimxev because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.

Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

@dshukertjr dshukertjr requested a review from a team November 24, 2025 12:05
@vercel
Copy link
vercel bot commented Nov 24, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
docs Ready Ready Preview, Comment Dec 16, 2025 1:08pm
zone-www-dot-com Ready Ready Preview, Comment Dec 16, 2025 1:08pm
6 Skipped Deployments
Project Deployment Review Updated (UTC)
studio Ignored Ignored Dec 16, 2025 1:08pm
cms Skipped Skipped Dec 16, 2025 1:08pm
design-system Skipped Skipped Dec 16, 2025 1:08pm
studio-self-hosted Skipped Skipped Dec 16, 2025 1:08pm
studio-staging Skipped Skipped Dec 16, 2025 1:08pm
ui-library Skipped Skipped Dec 16, 2025 1:08pm

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 24, 2025
@dshukertjr dshukertjr mentioned this pull request Nov 28, 2025
Merged
@ChrisChinchilla
Copy link
Contributor
ChrisChinchilla commented Dec 4, 2025

Thanks! Will get to this, but also have something of an internal planning and strategy around which frameworks to support, how to add them across the docs, etc…

@coderabbitai
Copy link
Contributor
coderabbitai bot commented Dec 16, 2025 •
edited
Loading

Walkthrough

Added an Expo React Native quickstart: a new navigation entry and a new MDX guide with a seven-step workflow for integrating Supabase into Expo projects. Also removed a triple-slash type reference from the docs next-env declaration.

Changes

Cohort / File(s) Change Summary
Documentation content
apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts, apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx		 Added a new "Expo React Native" entry to the Framework Quickstarts list and added a new MDX quickstart page that provides a 7-step setup (DB partial, create app, install deps, env vars, client init, App.tsx example, start dev server) plus next-step links.
Type declarations
apps/docs/next-env.d.ts		 Removed the triple-slash reference to ./.next/types/routes.d.ts.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify the new MDX follows docs style and code snippets are accurate and buildable.
  • Confirm the navigation constant path exactly matches the new MDX route.
  • Ensure removing the triple-slash reference does not break local type resolution or the docs build.

Poem

🐰 A quickstart hops into light,
Expo steps set up just right,
Seven hops, from DB to run,
Docs and menu — together, done!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: Add Expo quick start guide' clearly and concisely describes the main change—adding an Expo quick start guide to the documentation.
Description check ✅ Passed The description follows the template structure with sections for CONTRIBUTING.md confirmation and change type, though it lacks information in the 'current behavior' and 'new behavior' sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch guides/quickstarts
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 096bffb and b1b66c8.

📒 Files selected for processing (1)
  • apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (5)
📚 Learning: 2025-12-11T02:39:49.745Z 
Learnt from: CR
Repo: supabase/supabase PR: 0
File: .cursor/rules/docs-test-requirements.mdc:0-0
Timestamp: 2025-12-11T02:39:49.745Z
Learning: Applies to apps/docs/**/*.{test,spec}.ts : Before running tests in the docs application, check Supabase status using `pnpm supabase status`. If Supabase is not running, start it with `pnpm supabase start`. Reset the database with `pnpm supabase db reset --local` to ensure clean state. Run tests using `pnpm run -F docs test:local:unwatch` (without watch mode)

Applied to files:

  • apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx
📚 Learning: 2025-12-11T02:39:45.932Z 
Learnt from: CR
Repo: supabase/supabase PR: 0
File: .cursor/rules/docs-graphql.mdc:0-0
Timestamp: 2025-12-11T02:39:45.932Z
Learning: Applies to apps/docs/resources/**/[!Schema]*Resolver.ts : Use `supabase()` client for database operations with `convertPostgrestToApiError` for error handling in GraphQL resolvers

Applied to files:

  • apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx
📚 Learning: 2025-12-11T16:46:18.690Z 
Learnt from: CR
Repo: supabase/supabase PR: 0
File: .cursor/rules/studio-best-practices.mdc:0-0
Timestamp: 2025-12-11T16:46:18.690Z
Learning: Applies to apps/studio/**/*.tsx : Define prop interfaces explicitly for React components with proper typing of props and callback handlers

Applied to files:

  • apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx
📚 Learning: 2025-12-11T16:46:18.690Z 
Learnt from: CR
Repo: supabase/supabase PR: 0
File: .cursor/rules/studio-best-practices.mdc:0-0
Timestamp: 2025-12-11T16:46:18.690Z
Learning: Applies to apps/studio/**/*.{ts,tsx} : Use discriminated unions for complex state management instead of multiple independent state fields

Applied to files:

  • apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx
📚 Learning: 2025-12-11T16:46:18.690Z 
Learnt from: CR
Repo: supabase/supabase PR: 0
File: .cursor/rules/studio-best-practices.mdc:0-0
Timestamp: 2025-12-11T16:46:18.690Z
Learning: Applies to apps/studio/**/*.{ts,tsx} : Avoid type casting (e.g., `as any`, `as Type`); instead validate values at runtime using zod schemas

Applied to files:

  • apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: typecheck

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Dec 16, 2025
View reviewed changes
Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3e6b8fc and 096bffb.

📒 Files selected for processing (3)
  • apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts (1 hunks)
  • apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx (1 hunks)
  • apps/docs/next-env.d.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • apps/docs/next-env.d.ts
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-12-11T02:39:49.745Z 
Learnt from: CR
Repo: supabase/supabase PR: 0
File: .cursor/rules/docs-test-requirements.mdc:0-0
Timestamp: 2025-12-11T02:39:49.745Z
Learning: Applies to apps/docs/**/*.{test,spec}.ts : Before running tests in the docs application, check Supabase status using `pnpm supabase status`. If Supabase is not running, start it with `pnpm supabase start`. Reset the database with `pnpm supabase db reset --local` to ensure clean state. Run tests using `pnpm run -F docs test:local:unwatch` (without watch mode)

Applied to files:

  • apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx
📚 Learning: 2025-12-11T02:39:45.932Z 
Learnt from: CR
Repo: supabase/supabase PR: 0
File: .cursor/rules/docs-graphql.mdc:0-0
Timestamp: 2025-12-11T02:39:45.932Z
Learning: Applies to apps/docs/resources/**/[!Schema]*Resolver.ts : Use `supabase()` client for database operations with `convertPostgrestToApiError` for error handling in GraphQL resolvers

Applied to files:

  • apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build
  • GitHub Check: typecheck
🔇 Additional comments (2)
apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts (1)

358-361: LGTM!

The navigation entry is correctly structured and follows the existing pattern. The URL path aligns with the new MDX documentation page added in this PR.

apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx (1)

190-192: The URL paths in the Next steps section are correct and consistent with all other quickstart guides. All quickstart files (hono, nextjs, reactjs, sveltekit, expo-react-native) use the same /docs/guides/... format. The different pattern in NavigationMenu.constants.ts (/guides/...) is intentional—it's client-side navigation where Next.js automatically prepends the basePath (/docs), while static MDX content requires the full path. No broken links exist.

Likely an incorrect or invalid review comment.

ChrisChinchilla
ChrisChinchilla approved these changes Dec 16, 2025
View reviewed changes
Copy link
Contributor
@ChrisChinchilla ChrisChinchilla left a comment

Choose a reason for hiding this comment

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

I made some minor changes in a commit to add some new elements we've added to other quickstarts, apart from that 🚀

@dshukertjr dshukertjr merged commit e8694e4 into master Dec 16, 2025
23 checks passed
@dshukertjr dshukertjr deleted the guides/quickstarts branch December 16, 2025 22:37
This was referenced Dec 16, 2025
Merged
Merged
This was referenced Dec 29, 2025
Open
Closed
This was referenced Jan 8, 2026
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Jan 19, 2026
Merged
This was referenced Jan 28, 2026
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@ChrisChinchilla ChrisChinchilla ChrisChinchilla approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dshukertjr @ChrisChinchilla
0