mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
24be387cdb
## What kind of change does this PR introduce? Docs update. Aligns documentation and style guides with the **Sign in / Sign out / Sign up** platform standard. Closes DOCS-1328. Related to [#49874](https://github.com/supabase/supabase/pull/49874). ## What is the current behavior? Docs style guides prefer _login_ / _log in_. Guide prose uses mixed login and sign in wording. ## What is the new behavior? - [WORD_LIST.md](apps/docs/WORD_LIST.md) and [copywriting.mdx](apps/design-system/content/docs/copywriting.mdx) document the sign in standard - Design-system auth examples updated - Guide prose and API reference spec descriptions updated ### Terminology **Standard:** Use _sign in_, _sign out_, and _sign up_ as verbs. Use _sign-in_, _sign-out_, and _sign-up_ as nouns and adjectives. Match Studio UI labels (**Sign in**, **Sign out**, **Sign up**). **Preserved intentionally:** | Category | Keep as-is | Example | | -------- | ---------- | ------- | | Feature name | social login | `/social-login`, `features.mdx` heading, OAuth provider section | | URL slugs | `login` in paths | `/phone-login`, `/login-flows`, `choosing-login-flow` | | CLI | `supabase login` / `supabase logout` | Reference ids `supabase-login` / `supabase-logout`; executable commands unchanged | | SDK methods | `logout()` | Kotlin/Swift method names in API reference titles and examples | | Third-party UI | Provider product labels | Facebook Login, Kakao Login, portal **Login** buttons | | Postgres | Database terminology | login privileges, login credentials, login via role | | Audit/logging | Log prose | "Generates the following **log** in the Postgres Logs" | | Code and routes | Paths and filenames | `app/login/`, `Login.tsx`, `demos/android-login` | | External URLs | Third-party login pages | `dash.cloudflare.com/login`, `console.neon.tech/login`, `vercel.com/login` | | API identifiers | Event and field names | Audit actions `login`/`logout`, `should_logout_user` | ## To test - Run `pnpm lint:mdx` in `apps/docs` - Spot-check `features.mdx`, `social-login.mdx`, and a provider guide (e.g. Facebook, Kakao) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Standardized authentication terminology across guides, reference material, CLI documentation, and copywriting guidance using “sign in,” “sign out,” and “sign up.” * Updated authentication instructions, headings, link text, examples, and SSO guidance for clearer, more consistent wording. * Corrected related grammar, spelling, hyphenation, and documentation links while preserving established product names and implementation commands. * **Style** * Refined code examples with consistent import ordering and spacing. * **Examples** * Updated authentication button and menu labels to “Sign in” and “Sign out.” <!-- end of auto-generated comment: release notes by coderabbit.ai -->
138 lines
4.2 KiB
Plaintext
138 lines
4.2 KiB
Plaintext
---
|
|
title: 'Build a User Management App with React'
|
|
description: 'Learn how to use Supabase in your React App.'
|
|
---
|
|
|
|
<$Partial path="uiLibCta.mdx" />
|
|
<$Partial path="quickstart_intro.mdx" />
|
|
|
|

|
|
|
|
<Admonition type="note">
|
|
|
|
If you get stuck while working through this guide, you can find the [full example on GitHub](https://github.com/supabase/supabase/tree/master/examples/user-management/react-user-management).
|
|
|
|
</Admonition>
|
|
|
|
<$Partial path="project_setup.mdx" variables={{ "framework": "react", "tab": "frameworks" }} />
|
|
|
|
## Building the app
|
|
|
|
Start building the React app from scratch.
|
|
|
|
### Initialize a React app
|
|
|
|
Use [Vite](https://vitejs.dev/guide/) to initialize an app called `supabase-react`:
|
|
|
|
```bash
|
|
npm create vite@latest supabase-react -- --template react
|
|
cd supabase-react
|
|
```
|
|
|
|
Install [supabase-js](https://github.com/supabase/supabase-js):
|
|
|
|
```bash
|
|
npm install @supabase/supabase-js
|
|
```
|
|
|
|
Save the environment variables in a `.env.local` file, using the Project URL and the key that you copied [earlier](#get-api-details).
|
|
|
|
<$CodeSample
|
|
path="/user-management/react-user-management/.env.example"
|
|
lines={[[1, -1]]}
|
|
meta="name=.env"
|
|
/>
|
|
|
|
With the API credentials in place, create a helper file to initialize the Supabase client. The application exposes these variables in the browser, and that's fine as Supabase enables [Row Level Security](/docs/guides/database/postgres/row-level-security) by default on all tables.
|
|
|
|
Create and edit `src/supabaseClient.js`:
|
|
|
|
<$CodeSample
|
|
path="/user-management/react-user-management/src/supabaseClient.js"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/supabaseClient.js"
|
|
/>
|
|
|
|
### App styling (optional)
|
|
|
|
An optional step is to update the CSS file `src/index.css` to make the app look better.
|
|
You can find the full contents of this file [in the example repository](https://raw.githubusercontent.com/supabase/supabase/master/examples/user-management/react-user-management/src/index.css).
|
|
|
|
### Set up a sign-in component
|
|
|
|
You need a React component to manage sign-ins and sign-ups. It uses [Magic Links](/docs/guides/auth/auth-email-passwordless#with-magic-link), so users can sign in with their email without using passwords.
|
|
|
|
<Admonition type="note" title="Did you know?">
|
|
|
|
You can customize other emails sent out to new users, including the email's looks, content, and query parameters from [the **Authentication > Email**](/dashboard/project/_/auth/templates) section of the Dashboard.
|
|
|
|
</Admonition>
|
|
|
|
Create and edit `src/Auth.jsx`:
|
|
|
|
<$CodeSample
|
|
path="/user-management/react-user-management/src/Auth.jsx"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/Auth.jsx"
|
|
/>
|
|
|
|
### Account page
|
|
|
|
After a user signs in, they need a way to edit their profile details and manage their accounts.
|
|
|
|
Create a new component called `src/Account.jsx` and add the following code:
|
|
|
|
<$CodeSample
|
|
path="/user-management/react-user-management/src/Account.jsx"
|
|
lines={[[1, 2], [4, 66], [74, -1]]}
|
|
meta="name=src/Account.jsx"
|
|
/>
|
|
|
|
## Profile photos
|
|
|
|
Add a way for users to upload a profile photo. Supabase configures every project with [Storage](/docs/guides/storage) for managing large files like photos and videos.
|
|
|
|
### Create an upload widget
|
|
|
|
Create `src/Avatar.jsx` and add the following code:
|
|
|
|
<$CodeSample
|
|
path="/user-management/react-user-management/src/Avatar.jsx"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/Avatar.jsx"
|
|
/>
|
|
|
|
### Update the Account component
|
|
|
|
With the Avatar component created, update `src/Account.jsx` to include it:
|
|
|
|
<$CodeSample
|
|
path="/user-management/react-user-management/src/Account.jsx"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/Account.jsx"
|
|
/>
|
|
|
|
### Launch!
|
|
|
|
With all the components in place, change the contents of `src/App.jsx` to include the new components and Auth logic.
|
|
|
|
<$Partial path="auth_methods.mdx" />
|
|
|
|
<$CodeSample
|
|
path="/user-management/react-user-management/src/App.jsx"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/App.jsx"
|
|
/>
|
|
|
|
Once that's done, run this in a terminal window:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
And then open the browser to [localhost:5173](http://localhost:5173) and you should see the completed app.
|
|
|
|

|
|
|
|
At this stage you have a fully functional application!
|