The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
docs: kaizen fixes to QuickStarts (#47481)
Saxon Fletcher0ae4f32ad975
diff --git a/apps/docs/components/StepHikeCompact/index.tsx b/apps/docs/components/StepHikeCompact/index.tsxindex 11491e5ab0b..ef1a7f08af7 100644--- a/apps/docs/components/StepHikeCompact/index.tsx+++ b/apps/docs/components/StepHikeCompact/index.tsx@@ -72,22 +72,46 @@ const Step: FC<PropsWithChildren<IStep>> = ({ children, title, step }) => {</div></div></div>- <div className="grid grid-cols-1 lg:grid-cols-12 lg:gap-10 lg:ml-12">{children}</div>+ <div+ className={cn(+ 'ml-12 flex min-w-0 flex-col',+ '[&_[data-step-hike=details]+[data-step-hike=code]]:mt-6',+ '[&_[data-step-hike=details]:not(:has(+[data-step-hike=code]))]:mb-6',+ '[&_[data-step-hike=code]]:mb-6',+ '[&_[data-step-hike=code]:last-child]:mb-0'+ )}+ >+ {children}+ </div></div>)}const Details: FC<PropsWithChildren<IDetails>> = ({ children, title, fullWidth = false }) => {return (- <div className={cn(fullWidth ? 'col-span-12' : 'col-span-5', 'ml-12', 'lg:ml-0')}>- <h3 className="not-prose mb-4 text-foreground text-base">{title}</h3>+ <div+ data-step-hike="details"+ className={cn(+ 'min-w-0',+ '[&_p:last-child]:mb-0 [&_ul:last-child]:mb-0 [&_ol:last-child]:mb-0',+ fullWidth && 'w-full'+ )}+ >+ {title && <h3 className="mt-0 text-foreground text-base">{title}</h3>}{children}</div>)}const Code: FC<PropsWithChildren<ICode>> = ({ children }) => {- return <div className="col-span-7 not-prose">{children}</div>+ return (+ <div+ data-step-hike="code"+ className="not-prose min-w-0 w-full [&_.shiki]:!my-0 [&_.shiki-wrapper]:!my-0"+ >+ {children}+ </div>+ )}StepHikeCompact.Step = Stepdiff --git a/apps/docs/content/_partials/quickstart_db_setup.mdx b/apps/docs/content/_partials/quickstart_db_setup.mdxindex 741f1c0c611..399ba639086 100644--- a/apps/docs/content/_partials/quickstart_db_setup.mdx+++ b/apps/docs/content/_partials/quickstart_db_setup.mdx@@ -70,7 +70,17 @@ curl -X POST https://api.supabase.com/v1/projects \</Tabs>-## 2. Set up your database+## 2. Install agent skills (optional)++[Agent Skills](/docs/guides/ai-tools/ai-skills) are curated instruction sets that give your AI agent procedural knowledge about working with Supabase.++Install them in your project with:++```bash+npx skills add supabase/agent-skills+```++## 3. Set up your databaseWhen your Supabase project is up and running, create an `instruments` table with some sample data.diff --git a/apps/docs/content/guides/getting-started/quickstarts/astrojs.mdx b/apps/docs/content/guides/getting-started/quickstarts/astrojs.mdxindex ac53e7cecfa..6b4665af590 100644--- a/apps/docs/content/guides/getting-started/quickstarts/astrojs.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/astrojs.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create an Astro app+## 4. Create an Astro appCreate an Astro app using the `npm create` command.@@ -15,7 +15,7 @@ npm create astro@latest my-appcd my-app```-## 4. Install Supabase client library and Node adapter+## 5. Install Supabase client library and Node adapterInstall the `supabase-js` client library and the `@astrojs/node` adapter to enable server-side rendering.@@ -23,7 +23,7 @@ Install the `supabase-js` client library and the `@astrojs/node` adapter to enabnpm install @supabase/supabase-js @astrojs/node```-## 5. Configure Astro for SSR+## 6. Configure Astro for SSRUpdate your `astro.config.mjs`.@@ -41,20 +41,22 @@ export default defineConfig({<$Partial path="api_settings.mdx" variables={{ "framework": "astro", "tab": "frameworks" }} />-## 6. Declare Supabase environment variables+## 7. Declare Supabase environment variablesCreate a `.env.local` file and populate with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=astro&tab=frameworks):-<$CodeTabs>+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=astro">+ Open Connect panel+ </a>+</Button>```text name=.env.localPUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>PUBLIC_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>```-</$CodeTabs>--## 7. Create a Supabase client helper+## 8. Create a Supabase client helperCreate a utility file to initialize the Supabase client:@@ -69,9 +71,7 @@ export function createServerClient() {}```-## 8. Query Supabase data from Astro--<$Partial path="uiLibCta.mdx" />+## 9. Query Supabase data from AstroCreate a new file at `src/pages/instruments.astro` and populate with the following.@@ -99,7 +99,7 @@ const { data: instruments } = await supabase.from("instruments").select();</html>```-## 9. Start the app+## 10. Start the appRun the development server, go to http://localhost:4321/instruments in your browser of choice to check the list of instruments.@@ -109,6 +109,7 @@ npm run dev## Next steps+- Explore [drop-in UI components](/ui) for your Supabase app- Set up [Auth](/docs/guides/auth) for your app- [Insert more data](/docs/guides/database/import-data) into your database- Upload and serve static files using [Storage](/docs/guides/storage)diff --git a/apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx b/apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdxindex 929196f8ea9..54a5cc8e10b 100644--- a/apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/expo-react-native.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create an Expo app+## 4. Create an Expo appCreate a minimal Expo app using the `create-expo-app` command with the blank TypeScript template.@@ -14,7 +14,7 @@ Create a minimal Expo app using the `create-expo-app` command with the blank Typnpx create-expo-app my-app --template blank-typescript```-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryThe fastest way to get started is to use the `@supabase/supabase-js` client library which provides a convenient interface for working with Supabase from a React Native app.@@ -26,10 +26,14 @@ cd my-app && npx expo install @supabase/supabase-js react-native-url-polyfill ex<$Partial path="api_settings.mdx" variables={{ "framework": "", "tab": "" }} />-## 5. Declare Supabase environment variables+## 6. Declare Supabase environment variablesCreate a `.env` file in the root of your project and populate it with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true).+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true">Open Connect panel</a>+</Button>+Expo requires environment variables to be prefixed with `EXPO_PUBLIC_` to be accessible in your app code.```text name=.env@@ -37,7 +41,7 @@ EXPO_PUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>EXPO_PUBLIC_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>```-## 6. Initialize the Supabase client+## 7. Initialize the Supabase clientCreate a helper file at `lib/supabase.ts` to initialize the Supabase client using the environment variables.@@ -63,7 +67,7 @@ export const supabase = createClient(supabaseUrl, supabasePublishableKey, {})```-## 7. Query data from the app+## 8. Query data from the appReplace the contents of `App.tsx` with the following code to fetch and display the instruments from your database.@@ -113,7 +117,7 @@ const styles = StyleSheet.create({})```-## 8. Start the app+## 9. Start the appRun the development server and scan the QR code with the Expo Go app on your phone, or press `i` for iOS simulator or `a` for Android emulator.diff --git a/apps/docs/content/guides/getting-started/quickstarts/flask.mdx b/apps/docs/content/guides/getting-started/quickstarts/flask.mdxindex 5efde4856a6..9895e3bee8d 100644--- a/apps/docs/content/guides/getting-started/quickstarts/flask.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/flask.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a Python app with Flask+## 4. Create a Python app with FlaskCreate a new directory for your Python app and set up a virtual environment.@@ -16,7 +16,7 @@ python3 -m venv venvsource venv/bin/activate```-## 4. Install Flask and the Supabase client library+## 5. Install Flask and the Supabase client libraryThe fastest way to get started is to use Flask for the web framework and the `supabase-py` client library which provides a convenient interface for working with Supabase from a Python app.@@ -28,20 +28,20 @@ pip install flask supabase<$Partial path="api_settings.mdx" variables={{ "framework": "", "tab": "" }} />-## 5. Create environment variables file+## 6. Create environment variables fileCreate a `.env` file in your project root and populate it with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true):-<$CodeTabs>+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true">Open Connect panel</a>+</Button>```text name=.envSUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>```-</$CodeTabs>--## 6. Query data from the app+## 7. Query data from the appInstall the `python-dotenv` package to load environment variables:@@ -82,7 +82,7 @@ if __name__ == '__main__':app.run(debug=True)```-## 7. Start the app+## 8. Start the appRun the Flask development server, and go to http://localhost:5000 in your browser, you should see the list of instruments.diff --git a/apps/docs/content/guides/getting-started/quickstarts/flutter.mdx b/apps/docs/content/guides/getting-started/quickstarts/flutter.mdxindex ab121a5d01c..ed84c166372 100644--- a/apps/docs/content/guides/getting-started/quickstarts/flutter.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/flutter.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a Flutter app+## 4. Create a Flutter appCreate a Flutter app using the `flutter create` command.@@ -14,7 +14,7 @@ Create a Flutter app using the `flutter create` command.flutter create my_app```-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryThe fastest way to get started is to use the [`supabase_flutter`](https://pub.dev/packages/supabase_flutter) client library which provides a convenient interface for working with Supabase from a Flutter app.@@ -26,10 +26,16 @@ supabase_flutter: ^2.0.0<$Partial path="api_settings.mdx" variables={{ "framework": "flutter", "tab": "mobiles" }} />-## 5. Initialize the Supabase client+## 6. Initialize the Supabase clientOpen `lib/main.dart` and edit the main function to initialize Supabase using your project URL and publishable key, which you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=flutter&tab=mobiles):+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=mobiles&framework=flutter">+ Open Connect panel+ </a>+</Button>+```dart name=lib/main.dartimport 'package:supabase_flutter/supabase_flutter.dart';@@ -44,7 +50,7 @@ Future<void> main() async {}```-## 6. Query data from the app+## 7. Query data from the appUse a `FutureBuilder` to fetch the data when the home page loads and display the query result in a `ListView`.@@ -101,7 +107,7 @@ class _HomePageState extends State<HomePage> {}```-## 7. Start the app+## 8. Start the appRun your app on a platform of your choosing! By default an app should launch in your web browser.@@ -112,7 +118,7 @@ Running the app on macOS requires additional configuration to [set the entitlemeflutter run```-## Setup deep links+## 9. Setup deep links (optional)Many sign in methods require deep links to redirect the user back to your app after authentication. Read more about setting deep links up for all platforms (including web) in the [Flutter Mobile Guide](/docs/guides/getting-started/tutorials/with-flutter#setup-deep-links).diff --git a/apps/docs/content/guides/getting-started/quickstarts/hono.mdx b/apps/docs/content/guides/getting-started/quickstarts/hono.mdxindex 6e20b75f2f3..afdd0c3bb24 100644--- a/apps/docs/content/guides/getting-started/quickstarts/hono.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/hono.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a Hono app+## 4. Create a Hono appBootstrap the Hono example app from the Supabase Samples using the CLI.@@ -14,7 +14,7 @@ Bootstrap the Hono example app from the Supabase Samples using the CLI.npx supabase@latest bootstrap hono```-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryThe `package.json` file in the project includes the necessary dependencies, including `@supabase/supabase-js` and `@supabase/ssr` to help with server-side auth.@@ -25,7 +25,7 @@ npm install{/* TODO: Not ideal for frameworks that have no entry in Connect */}<$Partial path="api_settings.mdx" variables={{ "framework": "", "tab": "frameworks" }} />-## 5. Set up the required environment variables+## 6. Set up the required environment variablesCopy the `.env.example` file to `.env` and update the values with your Supabase project URL and publishable key, which you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&tab=frameworks).@@ -35,7 +35,7 @@ Lastly, [enable anonymous sign-ins](/dashboard/project/_/auth/providers) in thecp .env.example .env```-## 6. Start the app+## 7. Start the appStart the app, go to http://localhost:5173.diff --git a/apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdx b/apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdxindex 9ca27640d1e..abcc97b0905 100644--- a/apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/ios-swiftui.mdx@@ -6,11 +6,11 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create an iOS SwiftUI app with Xcode+## 4. Create an iOS SwiftUI app with XcodeSelect the **Xcode > New Project > iOS > App** menu item.-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryAdd the [supabase-swift](https://github.com/supabase/supabase-swift) package to your app using the Swift Package Manager.@@ -20,10 +20,16 @@ Make sure to add `Supabase` product package as a dependency to your application<$Partial path="api_settings.mdx" variables={{ "framework": "swift", "tab": "mobiles" }} />-## 5. Initialize the Supabase client+## 6. Initialize the Supabase clientCreate a new `Supabase.swift` file add a new Supabase instance using your project URL and publishable key, which you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=swift&tab=mobiles):+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=mobiles&framework=swift">+ Open Connect panel+ </a>+</Button>+```swift name=Supabase.swiftimport Supabase@@ -33,7 +39,7 @@ let supabase = SupabaseClient()```-## 6. Create a data model for instruments+## 7. Create a data model for instrumentsCreate a decodable struct to deserialize the data from the database.@@ -46,7 +52,7 @@ struct Instrument: Decodable, Identifiable {}```-## 7. Query data from the app+## 8. Query data from the appUse a `task` to fetch the data from the database and display it using a `List`.@@ -79,11 +85,11 @@ struct ContentView: View {}```-## 8. Start the app+## 9. Start the appRun the app on a simulator or a physical device by hitting `Cmd + R` on Xcode.-## Setting up deep links+## 10. Setting up deep links (optional)If you want to implement authentication features like magic links or OAuth, you need to set up deep links to redirect users back to your app. For instructions on configuring custom URL schemes for your iOS app, see the [deep linking guide](/docs/guides/auth/native-mobile-deep-linking?platform=swift).diff --git a/apps/docs/content/guides/getting-started/quickstarts/kotlin.mdx b/apps/docs/content/guides/getting-started/quickstarts/kotlin.mdxindex d712b5f87a0..2bbd104cc3a 100644--- a/apps/docs/content/guides/getting-started/quickstarts/kotlin.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/kotlin.mdx@@ -6,11 +6,11 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create an Android app with Android Studio+## 4. Create an Android app with Android StudioSelect the **Android Studio > New > New Android Project** menu item.-## 4. Install dependencies+## 5. Install dependenciesOpen `build.gradle.kts` (app) file and add the serialization plugin, Ktor client, and Supabase client.@@ -36,7 +36,7 @@ dependencies {}```-## 5. Add internet access permission+## 6. Add internet access permissionAdd the following line to the `AndroidManifest.xml` file under the `manifest` tag and outside the `application` tag.@@ -48,7 +48,7 @@ Add the following line to the `AndroidManifest.xml` file under the `manifest` ta<$Partial path="api_settings.mdx" variables={{ "framework": "androidkotlin", "tab": "mobiles" }} />-## 6. Initialize the Supabase client+## 7. Initialize the Supabase clientYou can create a Supabase client whenever you need to perform an API call.@@ -56,6 +56,12 @@ For a quick example, create a client at the top of the `MainActivity.kt` file beReplace the `supabaseUrl` and `supabaseKey` with your own, which you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=androidkotlin&tab=mobiles):+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=mobiles&framework=androidkotlin">+ Open Connect panel+ </a>+</Button>+```kotlinimport ...@@ -68,7 +74,7 @@ val supabase = createSupabaseClient(...```-## 7. Create a data model for instruments+## 8. Create a data model for instrumentsCreate a serializable data class to represent the data from the database.@@ -82,7 +88,7 @@ data class Instrument()```-## 8. Query data from the app+## 9. Query data from the appUse `LaunchedEffect` to fetch data from the database and display it in a `LazyColumn`.@@ -135,6 +141,6 @@ fun InstrumentsList() {}```-## 9. Start the app+## 10. Start the appRun the app on an emulator or a physical device by clicking the `Run app` button in Android Studio.diff --git a/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx b/apps/docs/content/guides/getting-started/quickstarts/laravel.mdxindex d66857b498b..9201cde1ef5 100644--- a/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/laravel.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a Laravel project+## 4. Create a Laravel projectMake sure your PHP and Composer versions are up to date, then use `composer create-project` to scaffold a new Laravel project.@@ -16,7 +16,7 @@ See the [Laravel docs](https://laravel.com/docs/10.x/installation#creating-a-larcomposer create-project laravel/laravel example-app```-## 4. Install the authentication template+## 5. Install the authentication templateInstall [Laravel Breeze](https://laravel.com/docs/10.x/starter-kits#laravel-breeze), a basic implementation of all of Laravel's [authentication features](https://laravel.com/docs/10.x/authentication).@@ -25,7 +25,7 @@ composer require laravel/breeze --devphp artisan breeze:install```-## 5. Set up the Postgres connection details+## 6. Set up the Postgres connection detailsGo to [database.new](https://database.new) and create a new Supabase project. Save your database password securely.@@ -44,7 +44,7 @@ DB_CONNECTION=pgsqlDB_URL=postgres://postgres.xxxx:[email protected]:5432/postgres```-## 6. Change the default schema+## 7. Change the default schemaBy default Laravel uses the `public` schema. We recommend changing this as Supabase exposes the `public` schema as a [data API](/docs/guides/api).@@ -69,7 +69,7 @@ The schema you specify in `search_path` has to exist on Supabase. You can create],```-## 7. Run the database migrations+## 8. Run the database migrationsLaravel ships with database migration files that set up the required tables for Laravel Authentication and User Management.@@ -79,7 +79,7 @@ Note: Laravel does not use Supabase Auth but rather implements its own authenticphp artisan migrate```-## 8. Start the app+## 9. Start the appRun the development server. Go to http://127.0.0.1:8000 in a browser to see your application. You can also navigate to http://127.0.0.1:8000/register and http://127.0.0.1:8000/login to register and log in users.diff --git a/apps/docs/content/guides/getting-started/quickstarts/nextjs.mdx b/apps/docs/content/guides/getting-started/quickstarts/nextjs.mdxindex e3b46fd890e..c362f436523 100644--- a/apps/docs/content/guides/getting-started/quickstarts/nextjs.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/nextjs.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a Next.js app+## 4. Create a Next.js appUse the `create-next-app` command and the `with-supabase` template, to create a Next.js app pre-configured with [Cookie-based Auth](/docs/guides/auth/server-side/creating-a-client?queryGroups=package-manager&package-manager=npm&queryGroups=framework&framework=nextjs&queryGroups=environment&environment=server), [TypeScript](https://www.typescriptlang.org/), and [Tailwind CSS](https://tailwindcss.com/).@@ -16,22 +16,22 @@ npx create-next-app -e with-supabase<$Partial path="api_settings.mdx" variables={{ "framework": "nextjs", "tab": "frameworks" }} />-## 4. Declare Supabase environment variables+## 5. Declare Supabase environment variables-Rename `.env.example` to `.env.local` and populate with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=nextjs&tab=frameworks):+Rename `.env.example` to `.env.local` and populate with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=nextjs&tab=frameworks).-<$CodeTabs>+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=nextjs">+ Open Connect panel+ </a>+</Button>```text name=.env.localNEXT_PUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>```-</$CodeTabs>--## 5. Query Supabase data from Next.js--<$Partial path="uiLibCta.mdx" />+## 6. Query Supabase data from Next.jsCreate a new file at `app/instruments/page.tsx` and populate with the following.@@ -61,7 +61,7 @@ export default function Instruments() {</$CodeTabs>-## 6. Start the app+## 7. Start the appRun the development server, go to http://localhost:3000/instruments in a browser and you should see the list of instruments.@@ -71,6 +71,7 @@ npm run dev## Next steps+- Explore [drop-in UI components](/ui) for your Supabase app- Set up [Auth](/docs/guides/auth) for your app- [Insert more data](/docs/guides/database/import-data) into your database- Upload and serve static files using [Storage](/docs/guides/storage)diff --git a/apps/docs/content/guides/getting-started/quickstarts/nuxtjs.mdx b/apps/docs/content/guides/getting-started/quickstarts/nuxtjs.mdxindex 150f90b437e..49a3a33fd63 100644--- a/apps/docs/content/guides/getting-started/quickstarts/nuxtjs.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/nuxtjs.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a Nuxt app+## 4. Create a Nuxt appCreate a Nuxt app using the `npx nuxi` command.@@ -14,7 +14,7 @@ Create a Nuxt app using the `npx nuxi` command.npx nuxi@latest init my-app```-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryThe fastest way to get started is to use the `supabase-js` client library which provides a convenient interface for working with Supabase from a Nuxt app.@@ -26,10 +26,16 @@ cd my-app && npm install @supabase/supabase-js<$Partial path="api_settings.mdx" variables={{ "framework": "nuxt", "tab": "frameworks" }} />-## 5. Declare Supabase environment variables+## 6. Declare Supabase environment variablesCreate a `.env` file and populate with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=nuxt&tab=frameworks):+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=nuxt">+ Open Connect panel+ </a>+</Button>+<$CodeTabs>```text name=.env@@ -50,7 +56,7 @@ export default defineNuxtConfig({</$CodeTabs>-## 6. Query data from the app+## 7. Query data from the appIn `app.vue`, create a Supabase client using your config values and replace the existing content with the following code.@@ -79,7 +85,7 @@ onMounted(() => {</template>```-## 7. Start the app+## 8. Start the appStart the app, navigate to http://localhost:3000 in the browser, and you should see the list of instruments.diff --git a/apps/docs/content/guides/getting-started/quickstarts/reactjs.mdx b/apps/docs/content/guides/getting-started/quickstarts/reactjs.mdxindex 5e8e29d920b..ac83c95b4f7 100644--- a/apps/docs/content/guides/getting-started/quickstarts/reactjs.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/reactjs.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a React app+## 4. Create a React appCreate a React app using a [Vite](https://vitejs.dev/guide/) template.@@ -14,7 +14,7 @@ Create a React app using a [Vite](https://vitejs.dev/guide/) template.npm create vite@latest my-app -- --template react```-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryThe fastest way to get started is to use the `supabase-js` client library, which provides a convenient interface for working with Supabase from a React app.@@ -26,18 +26,22 @@ cd my-app && npm install @supabase/supabase-js<$Partial path="api_settings.mdx" variables={{ "framework": "react", "tab": "frameworks" }} />-## 5. Declare Supabase environment variables+## 6. Declare Supabase environment variables-Create a `.env.local` file and populate it with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=react&tab=frameworks):+Create a `.env.local` file and populate it with your Supabase URL and publishable key that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=react&tab=frameworks)++<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=react">+ Open Connect panel+ </a>+</Button>```text name=.env.localVITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>```-## 6. Query data from the app--<$Partial path="uiLibCta.mdx" />+## 7. Query data from the appReplace the contents of `App.jsx` with a `getInstruments` function that fetches the data and displays the query result on the page using a Supabase client.@@ -80,7 +84,7 @@ function App() {export default App```-## 7. Start the app+## 8. Start the appRun the development server, go to http://localhost:5173 in a browser, and you should see the list of instruments.@@ -90,6 +94,7 @@ npm run dev## Next steps+- Explore [drop-in UI components](/ui) for your Supabase app- Set up [Auth](/docs/guides/auth) for your app- [Insert more data](/docs/guides/database/import-data) into your database- Upload and serve static files using [Storage](/docs/guides/storage)diff --git a/apps/docs/content/guides/getting-started/quickstarts/refine.mdx b/apps/docs/content/guides/getting-started/quickstarts/refine.mdxindex deee438d6c2..ff202d6c2cb 100644--- a/apps/docs/content/guides/getting-started/quickstarts/refine.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/refine.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a Refine app+## 4. Create a Refine appCreate a [Refine](https://github.com/refinedev/refine) app using the [create refine-app](https://refine.dev/docs/getting-started/quickstart/).@@ -20,10 +20,16 @@ npm create refine-app@latest -- --preset refine-supabase my-app<$Partial path="api_settings.mdx" variables={{ "framework": "refine", "tab": "frameworks" }} />-## 4. Update `supabaseClient` with environment variables+## 5. Update `supabaseClient` with environment variablesUpdate the `supabaseClient` with the `SUPABASE_URL` and `SUPABASE_KEY` of your Supabase API, which you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=refine&tab=frameworks). The `supabaseClient` is used in auth provider and data provider methods that allow the Refine app to connect to your Supabase backend.+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=refine">+ Open Connect panel+ </a>+</Button>+```ts name=src/utility/supabaseClient.tsimport { createClient } from '@refinedev/supabase'@@ -40,7 +46,7 @@ export const supabaseClient = createClient(SUPABASE_URL, SUPABASE_KEY, {})```-## 5. Add instruments resource and pages+## 6. Add instruments resource and pagesUse the following code to automatically add resources and generate code for the pages to show the `instruments` data using Refine Inferencer.@@ -60,7 +66,7 @@ Read more on [how the Inferencer works is in the Refine docs](https://refine.devnpm run refine create-resource instruments```-## 6. Add routes for instruments pages+## 7. Add routes for instruments pagesAdd routes for the `list`, `create`, `show`, and `edit` pages.@@ -136,7 +142,7 @@ function App() {export default App```-## 7. View instruments pages+## 8. View instruments pagesStart the app with the following command:diff --git a/apps/docs/content/guides/getting-started/quickstarts/solidjs.mdx b/apps/docs/content/guides/getting-started/quickstarts/solidjs.mdxindex 7b87a50307b..e6f68a34189 100644--- a/apps/docs/content/guides/getting-started/quickstarts/solidjs.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/solidjs.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a SolidJS app+## 4. Create a SolidJS appCreate a SolidJS app using the `degit` command.@@ -14,7 +14,7 @@ Create a SolidJS app using the `degit` command.npx degit solidjs/templates/js my-app```-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryThe fastest way to get started is to use the `supabase-js` client library which provides a convenient interface for working with Supabase from a SolidJS app.@@ -26,20 +26,22 @@ cd my-app && npm install @supabase/supabase-js<$Partial path="api_settings.mdx" variables={{ "framework": "solidjs", "tab": "frameworks" }} />-## 5. Declare Supabase environment variables+## 6. Declare Supabase environment variablesCreate a `.env.local` file and populate with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=solidjs&tab=frameworks):-<$CodeTabs>+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=solidjs">+ Open Connect panel+ </a>+</Button>```text name=.env.localVITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>```-</$CodeTabs>--## 6. Query data from the app+## 7. Query data from the appIn `App.jsx`, create a Supabase client to fetch the instruments data.@@ -72,7 +74,7 @@ function App() {export default App```-## 7. Start the app+## 8. Start the appStart the app and go to http://localhost:3000 in a browser and you should see the list of instruments.diff --git a/apps/docs/content/guides/getting-started/quickstarts/sveltekit.mdx b/apps/docs/content/guides/getting-started/quickstarts/sveltekit.mdxindex 6c5c08cc444..65ca944271b 100644--- a/apps/docs/content/guides/getting-started/quickstarts/sveltekit.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/sveltekit.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a SvelteKit app+## 4. Create a SvelteKit appCreate a SvelteKit app using the `npm create` command.@@ -14,7 +14,7 @@ Create a SvelteKit app using the `npm create` command.npx sv create my-app```-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryThe fastest way to get started is to use the `supabase-js` client library which provides a convenient interface for working with Supabase from a SvelteKit app.@@ -26,20 +26,22 @@ cd my-app && npm install @supabase/supabase-js<$Partial path="api_settings.mdx" variables={{ "framework": "sveltekit", "tab": "frameworks" }} />-## 5. Declare Supabase environment variables+## 6. Declare Supabase environment variablesCreate a `.env` file at the root of your project and populate with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=sveltekit&tab=frameworks):-<$CodeTabs>+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=sveltekit">+ Open Connect panel+ </a>+</Button>```text name=.envPUBLIC_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>PUBLIC_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>```-</$CodeTabs>--## 6. Create the Supabase client+## 7. Create the Supabase clientCreate a `src/lib` directory in your SvelteKit app, create a file called `supabaseClient.js` and add the following code to initialize the Supabase client:@@ -61,7 +63,7 @@ export const supabase = createClient(PUBLIC_SUPABASE_URL, PUBLIC_SUPABASE_PUBLIS</$CodeTabs>-## 7. Query data from the app+## 8. Query data from the appUse `load` method to fetch the data server-side and display the query results as a list.@@ -120,7 +122,7 @@ Replace the existing content in your `+page.svelte` file in the `src/routes` dir</ul>```-## 8. Start the app+## 9. Start the appStart the app and go to http://localhost:5173 in a browser and you should see the list of instruments.diff --git a/apps/docs/content/guides/getting-started/quickstarts/tanstack.mdx b/apps/docs/content/guides/getting-started/quickstarts/tanstack.mdxindex cd9dc019fa6..5b6df768d7b 100644--- a/apps/docs/content/guides/getting-started/quickstarts/tanstack.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/tanstack.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a TanStack Start app+## 4. Create a TanStack Start appCreate a TanStack Start app using the official CLI.@@ -14,7 +14,7 @@ Create a TanStack Start app using the official CLI.npm create @tanstack/start@latest my-app -- --package-manager npm --toolchain biome```-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryThe fastest way to get started is to use the `supabase-js` client library which provides a convenient interface for working with Supabase from a TanStack Start app.@@ -26,20 +26,20 @@ cd my-app && npm install @supabase/supabase-js<$Partial path="api_settings.mdx" variables={{ "framework": "", "tab": "" }} />-## 5. Declare Supabase environment variables+## 6. Declare Supabase environment variablesCreate a `.env` file in the root of your project and populate with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true):-<$CodeTabs>+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true">Open Connect panel</a>+</Button>```text name=.envVITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>```-</$CodeTabs>--## 6. Create a Supabase client utility+## 7. Create a Supabase client utilityCreate a new file at `src/utils/supabase.ts` to initialize the Supabase client.@@ -52,9 +52,7 @@ export const supabase = createClient()```-## 7. Query data from the app--<$Partial path="uiLibCta.mdx" />+## 8. Query data from the appReplace the contents of `src/routes/index.tsx` with the following code to add a loader function that fetches the instruments data and displays it on the page.@@ -84,7 +82,7 @@ function Home() {}```-## 8. Start the app+## 9. Start the appRun the development server, go to http://localhost:3000 in a browser and you should see the list of instruments.@@ -94,6 +92,7 @@ npm run dev## Next steps+- Explore [drop-in UI components](/ui) for your Supabase app- Set up [Auth](/docs/guides/auth) for your app- [Insert more data](/docs/guides/database/import-data) into your database- Upload and serve static files using [Storage](/docs/guides/storage)diff --git a/apps/docs/content/guides/getting-started/quickstarts/vue.mdx b/apps/docs/content/guides/getting-started/quickstarts/vue.mdxindex 30ea51f9a01..fa1deddd069 100644--- a/apps/docs/content/guides/getting-started/quickstarts/vue.mdx+++ b/apps/docs/content/guides/getting-started/quickstarts/vue.mdx@@ -6,7 +6,7 @@ breadcrumb: 'Framework Quickstarts'<$Partial path="quickstart_db_setup.mdx" />-## 3. Create a Vue app+## 4. Create a Vue appCreate a Vue app using the `npm init` command.@@ -14,7 +14,7 @@ Create a Vue app using the `npm init` command.npm init vue@latest my-app```-## 4. Install the Supabase client library+## 5. Install the Supabase client libraryThe fastest way to get started is to use the `supabase-js` client library which provides a convenient interface for working with Supabase from a Vue app.@@ -26,20 +26,22 @@ cd my-app && npm install @supabase/supabase-js<$Partial path="api_settings.mdx" variables={{ "framework": "vue", "tab": "frameworks" }} />-## 5. Declare Supabase environment variables+## 6. Declare Supabase environment variablesCreate a `.env.local` file and populate with your Supabase connection variables that you can get from the helper above, or [from the project **Connect** panel](/dashboard/project/_?showConnect=true&framework=vue&tab=frameworks):-<$CodeTabs>+<Button variant="primary" asChild>+ <a href="/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=vue">+ Open Connect panel+ </a>+</Button>```text name=.env.localVITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>```-</$CodeTabs>--## 6. Create the Supabase client+## 7. Create the Supabase clientCreate a `/src/lib` directory in your Vue app, create a file called `supabaseClient.js` and add the following code to initialize the Supabase client:@@ -52,7 +54,7 @@ const supabasePublishableKey = import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEYexport const supabase = createClient(supabaseUrl, supabasePublishableKey)```-## 7. Query data from the app+## 8. Query data from the appReplace the existing content in your `App.vue` file with the following code.@@ -81,7 +83,7 @@ onMounted(() => {</template>```-## 8. Start the app+## 9. Start the appStart the app and go to http://localhost:5173 in a browser and you should see the list of instruments.diff --git a/apps/docs/features/docs/GuidesMdx.template.tsx b/apps/docs/features/docs/GuidesMdx.template.tsxindex d46e6636c10..7ba6e74b818 100644--- a/apps/docs/features/docs/GuidesMdx.template.tsx+++ b/apps/docs/features/docs/GuidesMdx.template.tsx@@ -82,7 +82,7 @@ const GuideTemplate = ({'relative','transition-all ease-out','duration-100',- 'col-span-12 md:col-span-9'+ 'col-span-12 md:col-span-8')}>{breadcrumbJsonLd && (@@ -91,21 +91,22 @@ const GuideTemplate = ({dangerouslySetInnerHTML={{ __html: breadcrumbJsonLd }}/>)}- <Breadcrumbs className="mb-2" />+ <Breadcrumbs className="mb-6" /><article// Used to get headings for the table of contentsid="sb-docs-guide-main-article"className="prose max-w-none">- <h1 className="mb-0 [&>p]:m-0">- <ReactMarkdown>{meta?.title || 'Supabase Docs'}</ReactMarkdown>- </h1>- {meta?.subtitle && (- <div className="mt-6 not-prose [&_p]:text-xl [&_p]:leading-7 text-foreground-light [&>p]:m-0">- <ReactMarkdown>{meta.subtitle}</ReactMarkdown>- </div>- )}- <hr className="not-prose border-t-0 border-b my-8" />+ <header className="mb-8">+ <h1 className="mt-0 mb-0 [&>p]:m-0">+ <ReactMarkdown>{meta?.title || 'Supabase Docs'}</ReactMarkdown>+ </h1>+ {meta?.subtitle && (+ <h2 className="mt-1 text-xl text-foreground-light [&>p]:m-0">+ <ReactMarkdown>{meta.subtitle}</ReactMarkdown>+ </h2>+ )}+ </header>{content && (<MDXRemoteBase source={content} options={mdxOptions} customPreprocess={(x) => x} />@@ -136,16 +137,17 @@ const GuideTemplate = ({hideToc={hideToc}className={cn('hidden md:flex',- 'col-span-3 self-start',+ 'md:col-span-3 md:col-start-10',+ 'self-start','sticky',/*** --header-height: height of nav* 1px: height of nav border- * 2rem: content padding+ * 3rem: content padding*/- 'top-[calc(var(--header-height)+1px+2rem)]',- // 3rem accounts for 2rem of top padding + 1rem of extra breathing room- 'max-h-[calc(100vh-var(--header-height)-3rem)]'+ 'top-[calc(var(--header-height)+1px+3rem)]',+ // 4rem accounts for 3rem of top padding + 1rem of extra breathing room+ 'max-h-[calc(100vh-var(--header-height)-4rem)]')}/></div>diff --git a/apps/docs/features/ui/guide/Guide.tsx b/apps/docs/features/ui/guide/Guide.tsxindex 9fa9b8c31c3..6c586e9297b 100644--- a/apps/docs/features/ui/guide/Guide.tsx+++ b/apps/docs/features/ui/guide/Guide.tsx@@ -1,11 +1,10 @@'use client'-import { createContext, useContext, type ReactNode } from 'react'-import { cn } from 'ui'-import GuidesTableOfContents from '~/components/GuidesSidebar'import { TocAnchorsProvider } from '~/features/docs/GuidesMdx.client'import { type GuideFrontmatter } from '~/lib/docs'+import { createContext, useContext, type ReactNode } from 'react'+import { cn } from 'ui'interface GuideContextValue {meta?: GuideFrontmatter@@ -39,7 +38,7 @@ export function Guide({ meta, children, className }: GuideProps) {'relative','transition-all ease-out','duration-100',- hideToc ? 'col-span-12' : 'col-span-12 md:col-span-9'+ hideToc ? 'col-span-12' : 'col-span-12 md:col-span-8')}>{children}@@ -49,16 +48,17 @@ export function Guide({ meta, children, className }: GuideProps) {video={meta?.tocVideo}className={cn('hidden md:flex',- 'col-span-3 self-start',+ 'md:col-span-3 md:col-start-10',+ 'self-start','sticky',/*** --header-height: height of nav* 1px: height of nav border- * 2rem: content padding+ * 3rem: content padding*/- 'top-[calc(var(--header-height)+1px+2rem)]',- // 3rem accounts for 2rem of top padding + 1rem of extra breathing room- 'max-h-[calc(100vh-var(--header-height)-3rem)]'+ 'top-[calc(var(--header-height)+1px+3rem)]',+ // 4rem accounts for 3rem of top padding + 1rem of extra breathing room+ 'max-h-[calc(100vh-var(--header-height)-4rem)]')}/>)}diff --git a/apps/docs/features/ui/guide/GuideArticle.tsx b/apps/docs/features/ui/guide/GuideArticle.tsxindex 4b4d57d9421..b23cce3aaab 100644--- a/apps/docs/features/ui/guide/GuideArticle.tsx+++ b/apps/docs/features/ui/guide/GuideArticle.tsx@@ -1,8 +1,7 @@+import Breadcrumbs from '~/components/Breadcrumbs'import { type ReactNode } from 'react'import { cn } from 'ui'-import Breadcrumbs from '~/components/Breadcrumbs'-interface GuideArticleProps {children: ReactNodeclassName?: string@@ -11,7 +10,7 @@ interface GuideArticleProps {export function GuideArticle({ children, className }: GuideArticleProps) {return (<>- <Breadcrumbs className="mb-2" />+ <Breadcrumbs className="mb-6" /><article// Used to get headings for the table of contentsid="sb-docs-guide-main-article"diff --git a/apps/docs/features/ui/guide/GuideHeader.tsx b/apps/docs/features/ui/guide/GuideHeader.tsxindex be7e79b1434..2a7992dcf10 100644--- a/apps/docs/features/ui/guide/GuideHeader.tsx+++ b/apps/docs/features/ui/guide/GuideHeader.tsx@@ -1,6 +1,7 @@'use client'import ReactMarkdown from 'react-markdown'+import { cn } from 'ui'import { useGuide } from './Guide'@@ -12,8 +13,8 @@ export function GuideHeader({ className }: GuideHeaderProps) {const { meta } = useGuide()return (- <div className={className}>- <h1 className="mb-0 [&>p]:m-0">+ <div className={cn('mb-8', className)}>+ <h1 className="mt-0 mb-0 [&>p]:m-0"><ReactMarkdown>{meta?.title || 'Supabase Docs'}</ReactMarkdown></h1>{meta?.subtitle && (@@ -21,7 +22,6 @@ export function GuideHeader({ className }: GuideHeaderProps) {<ReactMarkdown>{meta.subtitle}</ReactMarkdown></div>)}- <hr className="not-prose border-t-0 border-b my-8" /></div>)}diff --git a/apps/docs/layouts/DefaultLayout.tsx b/apps/docs/layouts/DefaultLayout.tsxindex 4e6ccfaff51..ddc0f386a5c 100644--- a/apps/docs/layouts/DefaultLayout.tsx+++ b/apps/docs/layouts/DefaultLayout.tsx@@ -4,4 +4,4 @@ import { cn } from 'ui'export const LayoutMainContent: FC<PropsWithChildren<{ className?: string }>> = ({className,children,-}) => <div className={cn('max-w-7xl px-5 mx-auto py-8', className)}>{children}</div>+}) => <div className={cn('max-w-6xl px-6 mx-auto pt-12 pb-6', className)}>{children}</div>