dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-05 09:25:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

consistency: clean up all links

Browse Source
This commit is contained in:
Copple committed 2022-08-03 14:12:59 +02:00
1 parent 68cab9a7c9
commit f80e5c796a
19 files changed
+48 -224
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apps/reference/_api/intro.md
+1 -1
View File
@@ -1,7 +1,7 @@
---
slug: /
sidebar_position: 1
sidebar_label: Introduction
sidebar_label: Supabase API
---
# Supabase API
apps/reference/_cli/intro.mdx
+1 -1
View File
@@ -2,7 +2,7 @@
id: intro
slug: /
sidebar_position: 1
sidebar_label: Introduction
sidebar_label: Supabase CLI
---
# Supabase CLI
apps/reference/_supabase_dart/intro.mdx
+2 -2
View File
@@ -1,10 +1,10 @@
---
id: intro
slug: /
sidebar_label: Introduction
sidebar_label: Supabase Dart Library
---
# Supabase Dart
# Supabase Dart Library
Dart libraries are built and supported by the community.
apps/reference/_supabase_dart_versioned_docs/version-1.0/intro.mdx
-28
View File
@@ -1,28 +0,0 @@
---
id: intro
slug: /
sidebar_label: Introduction
---
# Supabase Dart
Dart libraries are built and supported by the community.
```bash
dart pub add supabase
```
Find the source code on [GitHub](https://github.com/supabase/supabase-dart).
## Flutter
For Flutter project, you can use [supabase_flutter](https://github.com/supabase/supabase-flutter).
```bash
flutter pub add supabase_flutter
```
`supabase_flutter` plugin uses `supabase` plugin internally, and it adds some Flutter specific functionality such as handling deeplinks coming back from magic link verifications.
If you are creating a Flutter application, we recommend using `supabase_flutter` instead of `supabase`.
For the most part `supabase_flutter` shares the same API as `supabase` with few exceptions such as initialization or OAuth sign in.
apps/reference/_supabase_dart_versioned_docs/version-1.0/release-notes.mdx
-7
View File
@@ -1,7 +0,0 @@
---
id: release-notes
---
# Release Notes
Start your release notes here.
apps/reference/_supabase_dart_versioned_docs/version-1.0/usage.mdx
-115
View File
@@ -1,115 +0,0 @@
---
id: usage
title: Usage
---
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
Supabase Dart.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
## Initializing the client library
```dart
final supabase = SupabaseClient('<SUPABASE_URL>', '<SUPABASE_ANON_KEY>');
```
### Attributes
### Notes
## Dart
You can initialize a new Supabase client using the `SupabaseClient()` method.
The Supabase client is your entrypoint to the rest of the Supabase functionality
and is the easiest way to interact with everything we offer within the Supabase ecosystem.
## Flutter
For `supabase_flutter`, you will be using the static `initialize()` method on `Supabase` class.
### Examples
####
```dart
final supabase = SupabaseClient('https://xyzcompany.supabase.co', 'public-anon-key');
```
####
```dart title="main.dart"
Future<void> main() async {
await Supabase.initialize(url: 'https://xyzcompany.supabase.co', anonKey: 'public-anon-key');
runApp(MyApp());
}
```
## Create a new user.
```dart
final res = await supabase.auth.signUp('<USER_EMAIL>', '<USER_PASSWORD>');
```
### Attributes
### Notes
- By default, the user will need to verify their email address before logging in. If you would like to change this, you can disable "Email Confirmations" by going to Authentication -> Settings on [app.supabase.com](https://app.supabase.com)
- If "Email Confirmations" is turned on, a user is returned but session will be null
- If "Email Confirmations" is turned off, both a `user` and a `session` will be returned
- When the user confirms their email address, they will be redirected to localhost:3000 by default. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com)
### Examples
#### Sign up.
```dart
final res = await supabase.auth.signUp('example@email.com', 'example-password');
final user = res.data?.user;
final error = res.error;
```
#### Sign up with third-party providers.
```dart
// Use signInWithProvider()
```
apps/reference/_supabase_dart_versioned_sidebars/version-1.0-sidebars.json
-3
View File
@@ -1,3 +0,0 @@
{
"goTrueSidebar": ["intro", "usage", "release-notes"]
}
apps/reference/_supabase_dart_versions.json
+1 -1
View File
@@ -1 +1 @@
["1.0"]
[]
apps/reference/_supabase_js/intro.md
+2 -2
View File
@@ -1,9 +1,9 @@
---
slug: /
sidebar_position: 1
sidebar_label: Introduction
sidebar_label: Supabase JavaScript Library
---
# Supabase JavaScript Client
# Supabase JavaScript Library
Some docs
apps/reference/docusaurus.config.js
+1 -1
View File
@@ -53,7 +53,7 @@ const config = {
{
id: '_gotrue',
path: '_gotrue',
routeBasePath: 'gotrue',
routeBasePath: 'auth',
sidebarPath: require.resolve('./nav/gotrue_sidebars.js'),
breadcrumbs: false,
},
apps/reference/nav/_referenceNavbar.js
+22 -22
View File
@@ -79,31 +79,31 @@ const navbar = [
// GoTrue
{
to: 'gotrue',
to: 'auth',
position: 'left',
label: 'GoTrue Auth Server',
supabaseCustomNavBarRegex: '(^/gotrue$|gotrue/)',
},
{
type: 'docsVersionDropdown',
position: 'left',
docsPluginId: '_gotrue',
supabaseCustomNavBarRegex: '(^/gotrue$|gotrue/)',
label: 'Auth Server',
supabaseCustomNavBarRegex: '(^/auth$|auth/)',
},
// {
// type: 'docsVersionDropdown',
// position: 'left',
// docsPluginId: '_gotrue',
// supabaseCustomNavBarRegex: '(^/gotrue$|gotrue/)',
// },
// Storage
{
to: 'storage',
position: 'left',
label: 'GoTrue Auth Server',
supabaseCustomNavBarRegex: '(^/storage$|storage/)',
},
{
type: 'docsVersionDropdown',
position: 'left',
docsPluginId: '_storage',
label: 'Storage Server',
supabaseCustomNavBarRegex: '(^/storage$|storage/)',
},
// {
// type: 'docsVersionDropdown',
// position: 'left',
// docsPluginId: '_storage',
// supabaseCustomNavBarRegex: '(^/storage$|storage/)',
// },
/**
* COMMUNITY
@@ -114,12 +114,12 @@ const navbar = [
label: 'Supabase Dart SDK',
supabaseCustomNavBarRegex: '(^/supabase-dart$|supabase-dart/)',
},
{
type: 'docsVersionDropdown',
position: 'left',
docsPluginId: '_supabase_dart',
supabaseCustomNavBarRegex: '(^/supabase-dart$|supabase-dart/)',
},
// {
// type: 'docsVersionDropdown',
// position: 'left',
// docsPluginId: '_supabase_dart',
// supabaseCustomNavBarRegex: '(^/supabase-dart$|supabase-dart/)',
// },
]
module.exports = { navbar }
apps/reference/nav/_referenceSidebars.js
+11 -7
View File
@@ -20,14 +20,18 @@ const sidebars = {
link: { type: 'doc', id: 'about' },
collapsed: false,
items: [
{
type: 'link',
label: 'Supabase JavaScript Client',
href: '/supabase-js',
},
{ type: 'link', label: 'Supabase CLI', href: '/cli' },
{ type: 'link', label: 'Supabase API', href: '/api' },
{ type: 'link', label: 'Supabase Dart Client', href: '/supabase-dart' },
{
type: 'link',
label: 'Supabase JavaScript Library',
href: '/supabase-js',
},
{
type: 'link',
label: 'Supabase Dart Library',
href: '/supabase-dart',
},
],
},
// {
@@ -41,7 +45,7 @@ const sidebars = {
label: 'Self hosted',
collapsed: false,
items: [
{ type: 'link', label: 'Auth Server', href: '/gotrue' },
{ type: 'link', label: 'Auth Server', href: '/auth' },
{ type: 'link', label: 'Storage Server', href: '/storage' },
],
},
apps/reference/nav/api_sidebars.js
+1 -19
View File
@@ -16,25 +16,7 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
apiSidebar: [
{
type: 'category',
label: 'Supabase API',
// collapsible: false,
// link: {
// type: 'doc',
// id: 'intro',
// },
items: ['intro', 'usage', 'release-notes'],
},
// 'intro',
// {
// type: "category",
// label: "Release Notes",
// items: ["release-notes"],
// },
],
sidebar: ['intro', 'usage', 'release-notes'],
}
module.exports = sidebars
apps/reference/nav/cli_sidebars.js
+1 -1
View File
@@ -16,7 +16,7 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
cliSidebar: [
sidebar: [
'intro',
'usage',
'config',
apps/reference/nav/gotrue_sidebars.js
+1 -1
View File
@@ -16,7 +16,7 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
goTrueSidebar: [
sidebar: [
'intro',
'config',
'release-notes',
apps/reference/nav/storage_sidebars.js
+1 -1
View File
@@ -16,7 +16,7 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
storageSidebar: [
sidebar: [
'intro',
'usage',
'config',
apps/reference/nav/supabase_dart_sidebars.js
+1 -10
View File
@@ -16,16 +16,7 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
goTrueSidebar: [
'intro',
'usage',
'release-notes',
// {
// type: "category",
// label: "Release Notes",
// items: ["release-notes"],
// },
],
sidebar: ['intro', 'usage', 'release-notes'],
}
module.exports = sidebars
apps/reference/nav/supabase_js_sidebars.js
+1 -1
View File
@@ -16,7 +16,7 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
goTrueSidebar: [
sidebar: [
'intro',
'usage',
'release-notes',
apps/reference/src/theme/DocSidebar/Desktop/Content/index.js
+1 -1
View File
@@ -7,7 +7,7 @@ const subNavRoutes = [
// Add any routes which should have a subnav
'/api',
'/cli',
'/gotrue',
'/auth',
'/storage',
'/supabase-js',
'/supabase-dart',