mirror of
https://github.com/supabase/supabase.git
synced 2026-09-09 11:30:17 +08:00
Closes FE-3966 ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## Problem - The admonition uses both 'tip' and 'note', but the visual distinction has long-ago collapsed. - 'Note' is used far more frequently than 'tip' - The two are very similar and it is confusing to know which one to use when they are visually identical ## Solution Collapse 'tip' and 'note' into one by removing all places where there is 'tip' and updating all references to 'tip' into 'note'. **Note:** This PR also resolves new broken links flagged by the E2E docs checker. It may move to another PR since E2Es keep erroring. ### Specific changes See below for an AI-generated list of changes: - **Type system** — removed `'tip'` from `AdmonitionType`, its `TYPE_TO_VARIANT`/`TYPE_LABEL` entries, and the test case in [`packages/ui-patterns/src/Admonition/](packages/ui-patterns/src/Admonition/) - **Remark plugin** — [remarkAdmonition.ts](apps/docs/lib/mdx/plugins/remarkAdmonition.ts) now maps mkdocs `tip` → `note` - **Lint allowlist** — `tip` dropped from `supa-mdx-lint.config.toml` - **Content migration** — all 109 files with `type="tip"` (across `apps/docs`, `apps/www`, `apps/studio`) converted to `type="note"`; zero remaining hits confirmed by repo-wide grep - **Style guide** — `CONTRIBUTING.md` and `contributing/content.mdx` updated to describe 4 admonition types instead of 5 ### Usage before implementation See the usage table that points toward 'note' as being dominant across all apps: Here's the usage table: | Location | `note` | `tip` | |---|---|---| | apps/docs | ~480 | ~143 | | apps/studio | 34 | 6 | | apps/www (blog) | 19 | 3 | | packages/ui-patterns (tests) | 3 | 1 (parametrized) | | design-system / ui-library / packages/ui / packages/common | 0–1 (test fixture only) | 0 | ## Preview links | App | Page | Search text (Ctrl+F) | Verify | |---|---|---|---| | docs | [/docs/guides/ai-tools/byo-mcp](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai-tools/byo-mcp) | official MCP TypeScript SDK | callout's aria-label="Note" | | docs | [/docs/guides/ai-tools/mcp](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai-tools/mcp) | MCP server is available at | callout's aria-label="Note" | | docs | [/docs/guides/ai/python-clients](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai/python-clients) | Click Connect at the top of any project page | callout's aria-label="Note" | | docs | [/docs/guides/auth/audit-logs](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/auth/audit-logs) | Disabling Postgres storage reduces your database storage costs | callout's aria-label="Note" | | docs | [/docs/guides/database/tables](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/database/tables) | access a custom schema through the Supabase Data API | callout's aria-label="Note" | | docs | [/docs/guides/troubleshooting/edge-function-404-error-response](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/troubleshooting/edge-function-404-error-response) | Always configure an appropriate time frame | callout's aria-label="Note" (was single-quoted type='tip') | | www | [blog: cli-v2-config-as-code](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/cli-v2-config-as-code) | Detecting config drift | callout's aria-label="Note" | | www | [blog: cli-v2-config-as-code](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/cli-v2-config-as-code) | Setting Edge Function secrets | callout's aria-label="Note" | | www | [blog: nosql-mongodb-compatibility-with-ferretdb-and-flydotio](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/nosql-mongodb-compatibility-with-ferretdb-and-flydotio) | If your network supports IPv6 connections | callout's aria-label="Note" | Note: the `www` rows use the `zone-www-dot-com` preview host, not the `docs` one you gave — since blog pages are served from the www app, not docs. ## Manual testing 1. Open preview links for affected pages. 2. Inspect. Open console. 3. Paste the following in and see there is no 'Tip' on the page: ``` document.querySelectorAll('[role="alert"]').forEach(el => console.log(el.getAttribute('aria-label'), el.textContent.slice(0,60))) ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Standardized informational callouts across docs and tutorials from **“Tip”** to **“Note”**, updating multiple examples and guidance blocks. * Updated a few related doc references/links and conditional “Next steps” content. * **UI Updates** * Switched various in-app banners and notices to the **“Note”** style variant. * **Bug Fixes / Improvements** * Removed support for the retired **“Tip”** callout type and aligned docs linting, component behavior, and aria labeling to the remaining admonition types. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
190 lines
5.9 KiB
Plaintext
190 lines
5.9 KiB
Plaintext
---
|
|
title: 'Build a User Management App with Angular'
|
|
description: 'Learn how to use Supabase in your Angular App.'
|
|
---
|
|
|
|
<$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/angular-user-management).
|
|
|
|
</Admonition>
|
|
|
|
<$Partial path="project_setup.mdx" variables={{ "framework": "ionicangular", "tab": "mobiles" }} />
|
|
|
|
## Building the app
|
|
|
|
Start with building the Angular app from scratch.
|
|
|
|
### Initialize an Angular app
|
|
|
|
Use the [Angular CLI](https://angular.io/cli) to initialize an app called `supabase-angular` setting some defaults that you can change to suit your needs:
|
|
|
|
```bash
|
|
npx ng new supabase-angular --routing false --style css --standalone false --ssr false
|
|
cd supabase-angular
|
|
```
|
|
|
|
Install [supabase-js](https://github.com/supabase/supabase-js):
|
|
|
|
```bash
|
|
npm install @supabase/supabase-js
|
|
```
|
|
|
|
Create a `src/environments` directory and save API URL and key that you copied [earlier](#get-api-details) as environment variables in a new `src/environments/environment.ts` file.
|
|
|
|
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.
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/environments/environment.ts"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/environments/environment.ts"
|
|
/>
|
|
|
|
With the API credentials in place, create a `SupabaseService` with `ng g s supabase` and add the following code to initialize the Supabase client and implement functions to communicate with the Supabase API.
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/supabase.service.ts"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/supabase.service.ts"
|
|
/>
|
|
|
|
Optionally, update `src/styles.css` to style the app. You can find the full contents of this file [in the example repository](https://github.com/supabase/supabase/tree/master/examples/user-management/angular-user-management/src/styles.css).
|
|
|
|
### Set up a login component
|
|
|
|
You need an Angular component to manage logins and sign ups. The component 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 an `AuthComponent` with the `ng g c auth` Angular CLI command and add the following code.
|
|
|
|
<$CodeTabs>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/auth/auth.component.ts"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/auth/auth.component.ts"
|
|
/>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/auth/auth.component.html"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/auth/auth.component.html"
|
|
/>
|
|
|
|
</$CodeTabs>
|
|
|
|
### Account page
|
|
|
|
Users also need a way to edit their profile details and manage their accounts after signing in. Create an `AccountComponent` with the `ng g c account` Angular CLI command and add the following code.
|
|
|
|
<$CodeTabs>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/account/account.component.ts"
|
|
lines={[[1, 16], [27, -1]]}
|
|
meta="name=src/app/account/account.component.ts"
|
|
/>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/account/account.component.html"
|
|
lines={[[1, 1], [3, -1]]}
|
|
meta="name=src/app/account/account.component.html"
|
|
/>
|
|
|
|
</$CodeTabs>
|
|
|
|
## 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 an `AvatarComponent` with the `ng g c avatar` Angular CLI command and add the following code.
|
|
|
|
<$CodeTabs>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/avatar/avatar.component.ts"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/avatar/avatar.component.ts"
|
|
/>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/avatar/avatar.component.html"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/avatar/avatar.component.html"
|
|
/>
|
|
|
|
</$CodeTabs>
|
|
|
|
### Update the Account component
|
|
|
|
With the Avatar component created, update `AccountComponent` to include it:
|
|
|
|
<$CodeTabs>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/account/account.component.ts"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/account/account.component.ts"
|
|
/>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/account/account.component.html"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/account/account.component.html"
|
|
/>
|
|
|
|
</$CodeTabs>
|
|
|
|
You also need to change `app.module.ts` to include the `ReactiveFormsModule` from the `@angular/forms` package.
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/app.module.ts"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/app.module.ts"
|
|
/>
|
|
|
|
### Launch!
|
|
|
|
With all the components in place, change the contents of `AppComponent` to include the new components and Auth logic:
|
|
|
|
<$Partial path="auth_methods.mdx" />
|
|
|
|
<$CodeTabs>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/app.component.ts"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/app.component.ts"
|
|
/>
|
|
|
|
<$CodeSample
|
|
path="/user-management/angular-user-management/src/app/app.component.html"
|
|
lines={[[1, -1]]}
|
|
meta="name=src/app/app.component.html"
|
|
/>
|
|
|
|
</$CodeTabs>
|
|
|
|
Now run the application in a terminal:
|
|
|
|
```bash
|
|
npm run start
|
|
```
|
|
|
|
Open the browser to [localhost:4200](http://localhost:4200) and you should see the completed app.
|
|
|
|

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