Alaister Young
a4b6016757
A bunch of master changes landed during the merge that needed
follow-ups on the TanStack side:
- Pin @tanstack/react-query to ~5.83.0 (and devtools to ~5.90.2)
in apps/studio and apps/ui-library. A previous master merge had
bumped these to ^5.100.10, which changed mutation onSuccess/onError
to require a 4th MutationFunctionContext arg and broke every studio
mutation hook still using the 3-arg shape (~570 call sites).
- Cast WebCrypto inputs to BufferSource in lib/role-impersonation.ts,
lib/ai/util.ts, lib/telemetry.tsx — TS6's DOM lib tightened
Uint8Array's generic so encoder.encode() no longer matches BufferSource
without a hint.
- compat/next/script.tsx: omit `onLoad`/`onError` from the React script
attrs we extend so our DOM-flavoured callback signatures don't clash
with React's SyntheticEvent handlers.
- compat/next/link.tsx + compat/next/navigation.ts: TanStack Router
type tightening — cast `search` and `{strict: false}` since the new
ParamsReducerFn / UseParamsOptions shapes don't fit the Next-shaped
arguments we pass through.
- router.tsx: cast the QueryClient handed to setupRouterSsrQueryIntegration.
react-router-ssr-query pulls in query-core@5.100 as a peer; we pin
react-query to 5.83. The runtime class is identical, but TS treats the
two as nominally distinct because of #private fields.
- Mirror master's page-shape changes on the route shells: drop
dehydratedState passthroughs for pages that no longer accept it
(functions/code, functions/new, integrations/github/authorize,
org.[_], project.[_]); add them back via the wrapper pattern for
pages that do still require it (redeem, aws-marketplace-onboarding,
sql/examples, stripe/projects/login).
- routes/__root.tsx: rename unused `info` to `_info` to satisfy
noUnusedParameters.
- packages/ui AnimatedCounter / Space / Typography: drop the unused
`import React from 'react'` (TS6 noUnusedLocals).
- scripts/ratchet-eslint-rules.ts: bump child_process maxBuffer from
32MB to 128MB so local runs don't truncate the ESLint JSON payload.
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
masterand 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.
- Type:
- 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 pullfrequently 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
infrastructurerepo.
# You'll need to be on Node v20
# in /studio
## For external contributors
pnpm install # install dependencies
pnpm run dev # start dev server
## For internal contributors
## First clone the private supabase/platform repo and follow instructions for setting up mise
mise studio # Run from supabase/platform alongside `mise infra`
## For all
pnpm run test # run tests
pnpm run test -- --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=