Files
supabase/apps/studio
+14 247c72fff2 SQL Editor: CLI commands to import snippet as migration/seed (#17341)
* feat(sql-editor): cli commands to import snippet as migration/seed

* fix(sql-editor): reword to download snippet

* chore(sql-editor): update wording

* Move to tabed ui, move download button to context menu

* Inline

* feat: add react native auth blog and quickstart. (#19006)

* feat: add react native auth blog and quickstart.

* Grammarly check

* Minor edits.

* Added og image.

* chore: add password sign in and gif.

---------

Co-authored-by: Ramiro Nuñez Dosio <ramiro@supabase.io>

* fix: duplicate eslint dependency (#19028)

* Update sveltekit.mdx (#18998)

Extended authorization section of docs to mention use of Sveltekit sequence helper function for protecting routes alongside defining Supabase session. Also provided new code.

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* fix: add hello world example to edge functions quickstart (#19030)

* Fix project card status not showing (#19034)

* Fix project card status not showing

* Fix tooltip project card styling

* chore: update cli reference doc (#18934)

* Add docs for updating the image versions (#18160)

see #17930

* chore: fix casing of "encryption at rest" (#19032)

* chore: update self-hosted image versions (#18935)

chore: update image versions for docker/docker-compose.yml

* (docs) Update arg name that resulted from adapters release (#19024)

update arg name that resulted from adapters release

* docs: Fix an example (@supabase/ssr package) for Next.js API Route (#19009)

Update creating-a-client.mdx

replace `appendHeader` with `setHeader` for the Next.js API route example.

* chore: cleanup studio dependencies (#19040)

* Fix code text color (#19042)

* make dark: selector work again

* fix reference docs code color

* feat: remove note about tus rollout (#19007)

it has been rolled out to all projects

* docs: update language in database-size.mdx code block (#19033)

Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>
Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>

* Docs: Adds a page for enums (#18590)

* Adds a page for enums

* Adds some details on deleting values

* Update apps/docs/pages/guides/database/postgres/enums.mdx

Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>

* Update apps/docs/pages/guides/database/postgres/enums.mdx

Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>

* Update apps/docs/pages/guides/database/postgres/enums.mdx

Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>

* Update apps/docs/pages/guides/database/postgres/enums.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* removes dangerous operation

---------

Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update hugging-face.mdx: fix example curl request (#17667)

The example request did not match the example edge function because there is used prompt and in the curl script was used query

* docs: fix syntax error in create role command (#17755)

* Update auth-sso-saml.mdx (#17856)

* docs: Update auth-google.mdx (#18119)

* fix: Bump up Realtime to 2.25.35 (#19048)

* Update llamaindex.ipynb doc_hash to hash (#18838)

* Update llamaindex.ipynb doc_hash to hash

Update `doc_hash` to `hash` since running this as-is provided an `AttributeError`. 

Here's what the Python build-in `vars` gives me (truncated):

```python
{'id_': 'd94b1287-b3ef-4aba-ac6b-7a4e353b0327',
 'embedding': None,
 'metadata': {},
 'excluded_embed_metadata_keys': [],
 'excluded_llm_metadata_keys': [],
 'relationships': {},
 'hash': '4c702b4df575421e1d1af4b1fd50511b226e0c9863dbfffeccb8b689b8448f35',...}
```

* fix: SimpleWebPageReader & StorageContext imports

* chore: revert python version change

---------

Co-authored-by: Greg Richardson <greg.nmr@gmail.com>

* fix: add reference docs back to search index (#19054)

Reference docs weren't being indexed properly because the specs weren't
getting checked out at build time.

* docs: add RN videos and discoverability improvements. (#18633)

* docs: add RN videos and discoverability improvements.

* Apply suggestions from code review

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>

* chore: run prettier.

---------

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>

* docs: add getting started guide for Swift (#19044)

* docs: getting started guide for Swift

* Apply suggestions from code review

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Add new tutorial to menu

* Add correct image for tutorial

* style: format with-swift tutorial

* docs: add example to the repository

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Thor 雷神 Schaeff <5748289+thorwebdev@users.noreply.github.com>

* docs: Update mentions of `foreign table` to `referenced table` (#18656)

* replace foreignTable parameter with referencedTable parameter

* remove redirects

* rename any mentions of foreign table to referenced table

* fix one mention of foreign table

* update some links

* guide: add pgroonga videos to pgroonga guide (#19073)

add pgroonga videos to pgroonga guide

* docs(swift): rename `authStateChanges` and remove `File` from upload method (#19067)

docs: fix authStateChanges and upload documentation

* Small style fixes

* Style

* Update

* Update

* Update UI components positioning for DownloadSnippetModal

---------

Co-authored-by: Terry Sutton <saltcod@gmail.com>
Co-authored-by: Thor 雷神 Schaeff <5748289+thorwebdev@users.noreply.github.com>
Co-authored-by: Ramiro Nuñez Dosio <ramiro@supabase.io>
Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>
Co-authored-by: uncapped1599 <126204291+uncapped1599@users.noreply.github.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Lakshan Perera <lakshan@supabase.io>
Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>
Co-authored-by: Div Arora <darora@users.noreply.github.com>
Co-authored-by: Oliver Rice <github@oliverrice.com>
Co-authored-by: Taishi <taishi.k0903@gmail.com>
Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
Co-authored-by: Inian <inian1234@gmail.com>
Co-authored-by: Joseph Yu <39754176+joseph082@users.noreply.github.com>
Co-authored-by: Maidi <mareike.haug@web.de>
Co-authored-by: Shinya Fujino <shf0811@gmail.com>
Co-authored-by: Andrei Soroker <soroker@gmail.com>
Co-authored-by: Isaac Abotsi <abotsi@users.noreply.github.com>
Co-authored-by: Filipe Cabaço <filipe@supabase.io>
Co-authored-by: Jason R. Stevens, CFA <jason@thinkjrs.dev>
Co-authored-by: Guilherme Souza <grsouza@pm.me>
Co-authored-by: Tyler <18113850+dshukertjr@users.noreply.github.com>
2023-11-21 20:32:07 +08:00
..
2023-11-16 16:41:53 +00:00

Supabase Studio

A dashboard for managing your self-hosted Supabase project, and used on our hosted platform. Built with:

What's included

Studio is designed to work with existing deployments - either the local hosted, docker setup, or our CLI. It is not intended for managing the deployment and administration of projects - that's out of scope.

As such, the features exposed on Studio for existing deployments are limited to those which manage your database:

  • Table & SQL editors
    • Saved queries are unavailable
  • Database management
    • Policies, roles, extensions, replication
  • API documentation

Managing Project Settings

Project settings are managed outside of the Dashboard. If you use docker compose, you should manage the settings in your docker-compose file. If you're deploying Supabase to your own cloud, you should store your secrets and env vars in a vault or secrets manager.

How to contribute?

  • Branch from master and name your branches with the following structure
    • {type}/{branch_name}
      • Type: chore | fix | feature
      • The branch name is arbitrary — just make sure it summarizes the work.
  • When you send a PR to master, it will automatically tag members of the frontend team for review.
  • Review the contributing checklists to help test your feature before sending a PR.
  • The Dashboard is under active development. You should run git pull frequently to make sure you're up to date.

Developer Quickstart

Note

Supabase internal use: To develop on Studio locally with the backend services, see the instructions in the internal infrastructure repo.

# You'll need to be on Node v18
# in /studio

npm i # install dependencies
npm run dev:secrets:pull # Supabase internal use: if you are working on the platform version of the Studio
npm run dev # start dev server
npm run test # run tests
npm run -- --watch # run tests in watch mode

Running within a self-hosted environment

Follow the self-hosting guide to get started.

cd ..
cd docker
docker compose -f docker-compose.yml -f ./dev/docker-compose.dev.yml up

Once you've got that set up, update .env in the studio folder with the corresponding values.

POSTGRES_PASSWORD=
SUPABASE_ANON_KEY=
SUPABASE_SERVICE_KEY=

Then run the following commands to install dependencies and start the dashboard.

npm install
npm run dev

If you would like to configure different defaults for "Default Organization" and "Default Project", you will need to update the .env in the studio folder with the corresponding values.

DEFAULT_ORGANIZATION_NAME=
DEFAULT_PROJECT_NAME=