How to deploy a Supabase edge function?

 

Step 1: Install Supabase CLI

 

First, you need to have the Supabase CLI installed. The Supabase CLI allows you to manage your Supabase projects from the command line.

You can install it using npm:

npm install -g supabase

 

Step 2: Initialize Supabase Project

 

Once you have the CLI installed, you need to initialize a Supabase project. The following command will create a new Supabase project in the current directory:

supabase init

This initializes a Supabase folder structure in your project directory.

 

Step 3: Create an Edge Function

 

Now, create a new Edge Function. You need to create a folder where your function code will reside. Let's call it hello-world:

mkdir supabase/functions/hello-world
cd supabase/functions/hello-world

Inside the hello-world folder, create a new file index.ts:

touch index.ts

Put your function logic inside index.ts. Here's a simple example:

// supabase/functions/hello-world/index.ts
export const handler = async (req: Request): Promise<Response> => {
  return new Response("Hello, World!");
};

 

Step 4: Deploy the Edge Function

 

After writing your function code, you're ready to deploy it. Navigate back to the root of your Supabase project and run the following command:

supabase functions deploy hello-world

This command deploys the hello-world function to Supabase Edge Functions.

 

Step 5: Test the Function

 

To test the deployed function, you can invoke it using the Supabase CLI. Use the invoke command as shown below:

supabase functions invoke hello-world

This will run your function and provide the output in the terminal.

 

Step 6: Connect to Supabase Dashboard

 

For more advanced features, you may want to manage functions using the Supabase Dashboard. Log in to your Supabase account, navigate to your project, and go to the "Functions" section to see the function you just deployed.

Here you can view logs, monitor performance, and tweak settings specific to your Edge Function.

 

Additional Steps: Permissions and Security

 

Ensure that your function is secure and has the right permissions. Access controls settings can be tailored to your needs directly from the Supabase Dashboard under the "Auth" section. Depending on your use case, you might want to add JWT verification or other security measures to your edge function code.

 

By following these detailed steps, you can successfully deploy and manage a Supabase edge function in your project.