Recently I’ve started using supabase, so I wanted to share the best way (in my opinion) to work locally using docker.
After playing around with a test project, I’ve found that the best way to work locally with supabase is using docker.
The doc is quite limited, so here’s how I’ve done it (and how I’m still using it).
I’m assuming you already have docker installed on your machine, and you have a test project. It doesn’t need to be much, just a simple project with a few tables.
You project also needs
supabase as a dev dependency (or globally installed).
npm install supabase@latest --save-dev
The docker side of things
In order to initialize the configurations for your project, you need to run:
It will create a
supabase folder with a
config.toml file inside. You should not have to change it, but in case you need to, you can change a couple of things:
- ports for each service
- auth related config (allow signup, …)
- external auth providers (github, google, …)
Now that everything is setup, you can start your project with:
Once everything is ready, you’ll get access to:
- API URL:
- Database URL:
- Studio URL:
- Inbucket URL:
Assuming you haven’t changed the default ports in the
The database side of things
What you probably want to do if you’re not starting from scratch, is to use your existing database. So in order to dump your existing database, you need to run:
This will create the first migration file in
supabase/migrations and it will be used to init your database when you start or reset it.
You can create a
seed.sql file in the
supabase folder, if you want to setup the project with existing data (default testing user for instance).
Now when you do some changes on your local db, create a migration file:
supabase db diff -f "migration-name"
Or directly create a migration file, and add the changes you want to apply:
supabase db migrate create -n "migration-name"
If you want to double check everything works (which you probably should), reset your DB:
supabase db reset
The first migration will be run first, then all your migrations will be applied. Once that’s done, it will do the seeding.
Supabase recently updated their doc, so you can find additional info here: Supabase CLI documentation