Supabase Edge Function Examples

What are Supabase Edge Functions?

Supabase Edge Functions are written in TypeScript, run via Deno, and deployed with the Supabase CLI. Please download the latest version of the Supabase CLI, or upgrade it if you have it already installed.

Example Functions

The function examples are located in ./supabase/functions:

• browser-with-cors: Handle CORS headers for function invocations from browser environments.
• select-from-table-with-auth-rls: Retrieve data from an authenticated user via RLS.
• send-email-smtp: Send an email using SMTP credentials.
• stripe-webhooks: Handle Stripe Webhooks.
• telegram-bot: Webhook handler for Telegram bots using grammY.

Develop locally

• Run supabase start (make sure your Docker daemon is running.)
• Run supabase functions serve your-function-name
• Run the CURL command in the example function, or use the invoke method on the Supabase client or use the test client app.

Test

This example includes a create-react-app in the ./app/ directory which you can use as a sort of postman to make test requests both locally and to your deployed functions.

Test locally

• cd app
• npm install
• npm start

Note: when testing locally, the select dropdown doesn't have any effect, and invoke simply calls whatever function is currently served by the CLI.

Deploy

• Generate access token and log in to CLI
  • Navigate to https://app.supabase.com/account/tokens
  • Click "Generate New Token"
  • Copy newly created token
  • Run supabase login
  • Input your token when prompted
• Link your project
  • Within your project root run supabase link --project-ref your-project-ref
• Set up your secrets
  • Run supabase secrets set --from-stdin < .env to set the env vars from your .env file.
  • You can run supabase secrets list to check that it worked and also to see what other env vars are set by default.
• Deploy the function
  • Within your project root run supabase functions deploy payment-sheet
• In youre ./app/.env file remove the SUPA_FUNCTION_LOCALHOST variable and restart your Expo app.

Test deployed functions

This example includes a create-react-app in the ./app/ directory which you can use as a sort of postman to make test requests both locally and to your deployed functions.

• cd app
• cp .env.example .env
• Fill in your env vars from https://app.supabase.com/project/_/settings/api
• npm install
• npm start

👁⚡️👁

\o/ That's it, you can now invoke your Supabase Function via the supabase-js and supabase-dart client libraries. (More client libraries coming soon. Check the supabase-community org for details).

For more info on Supabase Functions, check out the docs and the examples.