mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
80 lines
3.3 KiB
Markdown
80 lines
3.3 KiB
Markdown
# Todo example using Supabase
|
|
|
|
- Frontend:
|
|
- [create-react-app](https://reactjs.org/docs/create-a-new-react-app.html). React Framework for building single-page applications.
|
|
- [Tailwind](https://tailwindcss.com/) for styling and layout.
|
|
- [Supabase.js](https://supabase.io/docs/library/getting-started) for user management and realtime data syncing.
|
|
- Backend:
|
|
- [app.supabase.io/](https://app.supabase.io/): hosted Postgres database with restful API for usage with Supabase.js.
|
|
|
|
## Demo
|
|
|
|
-not added-
|
|
|
|
## Deploy with Vercel
|
|
|
|
-not added-
|
|
|
|
## Build from scratch
|
|
|
|
### 1. Create new project
|
|
|
|
Sign up to Supabase - [https://app.supabase.io](https://app.supabase.io) and create a new project. Wait for your database to start.
|
|
|
|
### 2. Run "Todo List" Quickstart
|
|
|
|
Once your database has started, run the "Todo List" quickstart. Inside of your project, enter the `SQL editor` tab and scroll down until you see `TODO LIST: Build a basic todo list with Row Level Security`
|
|
|
|
### 3. Get the URL and Key
|
|
|
|
Go to the Project Settings (the cog icon), open the API tab, and find your API URL and `anon` key, you'll need these in the next step.
|
|
|
|
The `anon` key is your client-side API key. It allows "anonymous access" to your database, until the user has logged in. Once they have logged in, the keys will switch to the user's own login token. This enables row level security for your data. Read more about this [below](#postgres-row-level-security).
|
|
|
|
|
|
|
|
**_NOTE_**: The `service_role` key has full access to your data, bypassing any security policies. These keys have to be kept secret and are meant to be used in server environments and never on a client or browser.
|
|
|
|
You will be asked for a `REACT_APP_SUPABASE_URL` and `REACT_APP_SUPABASE_KEY`. Use the API URL and `anon` key from [step 3](#3.-get-the-url-and-key).
|
|
|
|
## Supabase details
|
|
|
|
### Postgres Row level security
|
|
|
|
This project uses very high-level Authorization using Postgres' Role Level Security.
|
|
When you start a Postgres database on Supabase, we populate it with an `auth` schema, and some helper functions.
|
|
When a user logs in, they are issued a JWT with the role `authenticated` and their UUID.
|
|
We can use these details to provide fine-grained control over what each user can and cannot do.
|
|
|
|
This is a trimmed-down schema, with the policies:
|
|
|
|
```sql
|
|
create table todos (
|
|
id bigint generated by default as identity primary key,
|
|
user_id uuid references auth.users not null,
|
|
task text check (char_length(task) > 3),
|
|
is_complete boolean default false,
|
|
inserted_at timestamp with time zone default timezone('utc'::text, now()) not null
|
|
);
|
|
|
|
alter table todos enable row level security;
|
|
|
|
create policy "Individuals can create todos." on todos for
|
|
insert with check (auth.uid() = user_id);
|
|
|
|
create policy "Individuals can view their own todos. " on todos for
|
|
select using (auth.uid() = user_id);
|
|
|
|
create policy "Individuals can update their own todos." on todos for
|
|
update using (auth.uid() = user_id);
|
|
|
|
create policy "Individuals can delete their own todos." on todos for
|
|
delete using (auth.uid() = user_id);
|
|
```
|
|
|
|
## Authors
|
|
|
|
- [Supabase](https://supabase.io)
|
|
|
|
Supabase is open source, we'd love for you to follow along and get involved at https://github.com/supabase/supabase
|