mirror of
https://github.com/supabase/supabase.git
synced 2026-07-22 15:37:14 -04:00
26248be753
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## Summary Adds two new optional onboarding steps — **Install Agent Skills** and **Install MCP server** — to every framework quickstart guide, right after the "create app" step, so readers are pointed at [Agent Skills](/docs/guides/ai-tools/ai-skills) and the [Supabase MCP server](/docs/guides/ai-tools/mcp) early in the setup flow. **Where each step lives:** - **16 quickstarts that include the shared `quickstart_db_setup.mdx` partial** (Next.js, Astro, Expo/React Native, Flask, Flutter, Hono, iOS/SwiftUI, Kotlin, Laravel, Nuxt, React, Refine, SolidJS, SvelteKit, TanStack Start, Vue): the partial itself now has a step 2 "Install MCP server (optional)" (between project creation and database setup), and each individual file gets its own "Install Agent Skills (optional)" step right after its app-creation step. - **RedwoodJS and Ruby on Rails** (don't use the shared partial): got both steps added inline, in the same order (Agent Skills, then MCP server), since they can't inherit from the partial. - All subsequent step numbers (and the "Step N" cross-references in prose, e.g. in RedwoodJS) were renumbered to stay sequential. ## Test plan - Check the quickstarts locally or in preview. - Any other ideas on how to optimise showing these items? - Does the SQL prefill add anything? - Other ideas on how to simplify without losing the information? - Check the MD output too and see if that also makes sense. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Refreshed multiple getting-started quickstarts with consistent, clearer step sequencing (including renumbering) across frameworks. * Added an optional “Install Agent Skills” step where applicable, plus updated placements of shared environment-variable setup content. * Simplified the database quickstart flow: single “Create a Supabase project” step, streamlined SQL Editor instructions for creating an `instruments` table, enabling RLS, and granting public read access. * Added optional “Install MCP server” steps in the relevant quickstarts. * **Style** * Updated MDX linting rules to allow the uppercase phrase “Agent Skills”. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Jeremias Menichelli <jmenichelli@gmail.com> Co-authored-by: Nik Richers <nrichers@gmail.com>
111 lines
3.0 KiB
Plaintext
111 lines
3.0 KiB
Plaintext
---
|
|
title: 'Use Supabase with React'
|
|
subtitle: 'Learn how to create a Supabase project, add some sample data to your database, and query the data from a React app.'
|
|
breadcrumb: 'Framework Quickstarts'
|
|
---
|
|
|
|
<$Partial path="quickstart_db_setup.mdx" />
|
|
|
|
## 3. Create a React app
|
|
|
|
Create a React app using a [Vite](https://vitejs.dev/guide/) template.
|
|
|
|
```bash
|
|
npm create vite@latest my-app -- --template react
|
|
```
|
|
|
|
## 4. Install Agent Skills (optional)
|
|
|
|
Supabase's [Agent Skills](/docs/guides/ai-tools/ai-skills) is a curated set of instructions that give your AI agent procedural knowledge about working with Supabase.
|
|
|
|
To install, run the following command in the root of your project:
|
|
|
|
```bash
|
|
npx skills add supabase/agent-skills
|
|
```
|
|
|
|
## 5. Install the Supabase client library
|
|
|
|
The 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.
|
|
|
|
Navigate to the React app and install `supabase-js`.
|
|
|
|
```bash
|
|
cd my-app && npm install @supabase/supabase-js
|
|
```
|
|
|
|
## 6. Declare Supabase environment variables
|
|
|
|
Create a `.env.local` file and populate it with your Supabase URL and publishable key that you can get from the helper below, 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.local
|
|
VITE_SUPABASE_URL=<SUBSTITUTE_SUPABASE_URL>
|
|
VITE_SUPABASE_PUBLISHABLE_KEY=<SUBSTITUTE_SUPABASE_PUBLISHABLE_KEY>
|
|
```
|
|
|
|
<$Partial path="api_settings.mdx" variables={{ "framework": "react", "tab": "frameworks" }} />
|
|
|
|
## 7. Query data from the app
|
|
|
|
Replace 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.
|
|
|
|
```js name=src/App.jsx
|
|
import { createClient } from '@supabase/supabase-js'
|
|
import { useEffect, useState } from 'react'
|
|
|
|
const supabase = createClient(
|
|
import.meta.env.VITE_SUPABASE_URL,
|
|
import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEY
|
|
)
|
|
|
|
function App() {
|
|
const [instruments, setInstruments] = useState([])
|
|
|
|
useEffect(() => {
|
|
getInstruments()
|
|
}, [])
|
|
|
|
async function getInstruments() {
|
|
const { data, error } = await supabase.from('instruments').select()
|
|
|
|
if (error) {
|
|
console.error(error)
|
|
return
|
|
}
|
|
|
|
setInstruments(data)
|
|
}
|
|
|
|
return (
|
|
<ul>
|
|
{instruments.map((instrument) => (
|
|
<li key={instrument.name}>{instrument.name}</li>
|
|
))}
|
|
</ul>
|
|
)
|
|
}
|
|
|
|
export default App
|
|
```
|
|
|
|
## 8. Start the app
|
|
|
|
Run the development server, go to http://localhost:5173 in a browser, and you should see the list of instruments.
|
|
|
|
```bash
|
|
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)
|