Files
supabase/apps/reference/docs/reference.mdx
Copple 42ea5eeaad Docs: realtime self-hosted (#9843)
* Adds a generated folder

* Adds a realtime section

* docs: add Realtime v0 self-host parameters (#9915)

Co-authored-by: Wen Bo Xie <5532241+w3b6x9@users.noreply.github.com>
2022-10-28 13:35:46 +02:00

83 lines
2.7 KiB
Plaintext

---
id: reference
title: Reference Documentation
sidebar_label: Reference Documentation
hide_table_of_contents: true
---
import Link from '@docusaurus/Link'
import ButtonCard from '@site/src/components/ButtonCard'
import useBaseUrl from '@docusaurus/useBaseUrl'
Reference documentation for the official Supabase client libraries, APIs, and tools.
<div class="container" style={{ padding: 0 }}>
<div class="row is-multiline">
{/* Javascript */}
<div class="col col--6">
<ButtonCard
icon={useBaseUrl("/img/icons/javascript-icon.svg")}
class="card"
to={useBaseUrl("/reference/javascript")}
style={{ height: '100%' }}
title="JavaScript"
description="JavaScript and TypeScript documentation."
/>
</div>
{/* DART */}
<div class="col col--6">
<ButtonCard icon={useBaseUrl("/img/icons/flutter-icon.svg")} class="card" to={useBaseUrl("/reference/dart")} style={{ height: '100%' }} title="Flutter" description="Flutter and Dart documentation."/>
</div>
{/* CLI */}
<div class="col col--6">
<ButtonCard icon={useBaseUrl("/img/icons/cli-icon.svg")} class="card" to={useBaseUrl("/reference/cli")} style={{ height: '100%' }} title="Supabase CLI" description="Tools for developing your Supabase projects locally."/>
</div>
{/* API */}
<div class="col col--6">
<ButtonCard icon={useBaseUrl("/img/icons/api-icon.svg")} class="card" to={useBaseUrl("/reference/api")} style={{ height: '100%' }} title="Management API" description="Manage your Supabase projects programmatically."/>
</div>
{/* */}
</div>
</div>
## Self-hosting
Reference documentation for self-hosting Supabase features.
<div class="container" style={{ padding: 0 }}>
<div class="row is-multiline">
{/* Examples - coming soon */}
<div class="col col--6">
<ButtonCard
class="card"
to={useBaseUrl('/reference/auth')}
style={{ height: '100%' }}
title={'Auth Server'}
description=" JSON Web Token (JWT)-based API for managing users and issuing access tokens."
/>
</div>
{/* */}
<div class="col col--6">
<ButtonCard
class="card"
to={useBaseUrl('/reference/realtime')}
style={{ height: '100%' }}
title={'Realtime'}
description="Build multiplayer applications and listen to your database changes via websockets."
/>
</div>
{/* */}
<div class="col col--6">
<ButtonCard
class="card"
to={useBaseUrl('/reference/storage')}
style={{ height: '100%' }}
title={'Storage'}
description="S3-compatible object storage service that integrates with Postgres."
/>
</div>
{/* */}
</div>
</div>