Use Supabase with Laravel

1. Create a Supabase project#

To start, you need a Supabase project.

Create a new Supabase project from the Dashboard of any organization you belong to.

2. Set up your database#

When your Supabase project is up and running, create an instruments table with some sample data. Then set only the privileges each Postgres role needs, add Row Level Security (RLS) for enhanced security for database data by default, and create an RLS policy to make the data in the table publicly readable.

Do these steps within your project's dashboard by copying and running the snippet in your project's SQL Editor.

1
-- Create the table
2
create table instruments (
3
  id bigint primary key generated always as identity,
4
  name text not null
5
);
6
7
-- Insert sample data into the table
8
insert into instruments (name)
9
values
10
  ('violin'),
11
  ('viola'),
12
  ('cello');
13
14
-- Grant the privileges the role needs, which is read access
15
grant select on public.instruments to anon;
16
17
-- Enable row level security for the table
18
alter table instruments enable row level security;
19
20
-- Create a policy to allow the anon role to read from the instruments table
21
create policy "public can read instruments"
22
on public.instruments
23
for select to anon
24
using (true);

3. Create a Laravel project#

Make sure your PHP and Composer versions are up to date, then use composer create-project to scaffold a new Laravel project.

See the Laravel docs for more details.

1
composer create-project laravel/laravel example-app

4. Install Agent Skills (optional)#

Supabase's Agent Skills is a curated set of instructions that give your AI agent procedural knowledge about working with Supabase.

To install, run the following command in the root of your project:

1
npx skills add supabase/agent-skills

5. Install the authentication template#

Install Laravel Breeze, a basic implementation of all of Laravel's authentication features.

1
composer require laravel/breeze --dev
2
php artisan breeze:install

6. Set up the Postgres connection details#

Go to database.new and create a new Supabase project. Save your database password securely.

When your project is up and running, navigate to your project dashboard and click on Connect.

Look for the Session Pooler connection string and copy the string. You will need to replace the Password with your saved database password. You can reset your database password in your Database Settings if you do not have it.

1
DB_CONNECTION=pgsql
2
DB_URL=postgres://postgres.xxxx:password@xxxx.pooler.supabase.com:5432/postgres

7. Change the default schema#

By default Laravel uses the public schema. We recommend changing this as Supabase exposes the public schema as a data API.

You can change the schema of your Laravel application by modifying the search_path variable app/config/database.php.

The schema you specify in search_path has to exist on Supabase. You can create a new schema from the Table Editor.

1
'pgsql' => [
2
    'driver' => 'pgsql',
3
    'url' => env('DB_URL'),
4
    'host' => env('DB_HOST', '127.0.0.1'),
5
    'port' => env('DB_PORT', '5432'),
6
    'database' => env('DB_DATABASE', 'laravel'),
7
    'username' => env('DB_USERNAME', 'root'),
8
    'password' => env('DB_PASSWORD', ''),
9
    'charset' => env('DB_CHARSET', 'utf8'),
10
    'prefix' => '',
11
    'prefix_indexes' => true,
12
    'search_path' => 'laravel',
13
    'sslmode' => 'prefer',
14
],

8. Run the database migrations#

Laravel ships with database migration files that set up the required tables for Laravel Authentication and User Management.

Note: Laravel does not use Supabase Auth but rather implements its own authentication system!

1
php artisan migrate

9. Start the app#

Run the development server. Go to http://127.0.0.1:8000 in a browser to see your application. You can also navigate to http://127.0.0.1:8000/register and http://127.0.0.1:8000/login to register and log in users.

1
php artisan serve