mirror of
https://github.com/supabase/supabase.git
synced 2026-09-08 19:08:44 +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 -->
61 lines
2.9 KiB
Plaintext
61 lines
2.9 KiB
Plaintext
---
|
|
id: 'stripe-projects'
|
|
title: 'Stripe Projects'
|
|
description: 'Provision a Supabase project from the Stripe CLI'
|
|
---
|
|
|
|
## Overview
|
|
|
|
[Stripe Projects](https://docs.stripe.com/stripe-projects) is a workflow in the Stripe CLI that provisions real services and returns working credentials from a single command. Supabase is available in the catalog, so one command provisions a Postgres database along with the rest of Supabase (Auth, Storage, Edge Functions, and Realtime), without opening a dashboard.
|
|
|
|
Stripe Projects is designed for both humans and AI agents. The provisioning steps are deterministic and repeatable whether you run them yourself or an agent runs them for you.
|
|
|
|
<Admonition type="note">
|
|
|
|
Stripe Projects is currently a developer preview. If you run into issues, [reach out on Discord](https://discord.supabase.com/) or open an issue on [GitHub](https://github.com/supabase/supabase/issues).
|
|
|
|
</Admonition>
|
|
|
|
## Quickstart
|
|
|
|
[Install the Stripe CLI](https://docs.stripe.com/stripe-cli/install), then run:
|
|
|
|
```bash
|
|
stripe plugin install projects
|
|
stripe projects init my-app
|
|
stripe projects add supabase/project
|
|
stripe projects env --sync
|
|
```
|
|
|
|
These commands create a new Supabase project in your account with a Postgres database ready to connect and write the project credentials to a local `.env` file. If you already have a Supabase account, the flow prompts you to link it instead of creating a new one.
|
|
|
|
To open the Supabase dashboard directly:
|
|
|
|
```bash
|
|
stripe projects open supabase
|
|
```
|
|
|
|
To rotate your database credentials:
|
|
|
|
```bash
|
|
stripe projects rotate supabase/project
|
|
```
|
|
|
|
For the full command reference, see [Stripe's Stripe Projects docs](https://docs.stripe.com/stripe-projects).
|
|
|
|
## Authorizing the request
|
|
|
|
The first time you provision a project this way, Supabase shows an authorization screen so you can confirm the request before anything is created:
|
|
|
|
- If you're not signed in to Supabase with the email Stripe has on file, you're asked to sign out and back in as that account.
|
|
- If the Stripe account is already linked to a Supabase organization, you confirm the request.
|
|
- Otherwise, confirming creates a new Supabase organization on your behalf.
|
|
|
|
Your Supabase project and organization work exactly like ones you create directly: you keep full access to the dashboard, your connection strings, and your data. Nothing is proxied or white-labeled.
|
|
|
|
## Limitations
|
|
|
|
- Stripe Projects is in developer preview, so behavior may change.
|
|
- Provisioning links to a Supabase organization by matching the email on the Stripe account to a Supabase account; there's no option in the CLI flow to choose a different existing organization.
|
|
- To access the Supabase dashboard for a new organization provisioned through Stripe Projects, use the `open` command (`stripe projects open supabase`). To sign in to the Supabase dashboard directly without the CLI, follow the reset password flow for this account.
|