Jordi EnricandCharis
c75bb1b60d
* move to new ReportConfig * separate types * add auth report config * add auth report transofmration test * add fetchlogs util for reports * rm auth-charts * rm auth-report-query * rm dupped code * simplify upsell compo * rm unnecessary hook * use upsell in database report instead of old component * rip ReportChart you wont be missed * more tests * rm unnecessary import * Fix SQL in active users * support hide inside report chart component * add max bar size to avoid having big ass bars when theres little data * fix incorrect timestamp key passed on to fillTimeseries * add tooltip to auth report * fix bug with timestamp key inside tooltips * add report settings * rm debugging check * Update apps/studio/data/reports/v2/auth.config.ts Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> * safely access result * fix sign in latency query * add toggleable attributes * handle toggleable attributes * pass on hideHighlightedValue * fix signup latency * pass hideHighlighted * report chart pass on hide highlighted value * cleanup finalChartData * simplify tests, use timestamp for everything * fix test * rm dupped attribute * add tooltip to auth errors * Update apps/studio/data/reports/v2/auth.config.ts Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> * Update apps/studio/components/ui/Charts/ComposedChart.tsx Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> * prettify --------- Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
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
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=