Getting Started with Edge Functions

This guide walks you through creating, testing locally, deploying, and invoking a Zuvo Edge Function using the CLI. By the end, you'll have a working function running on Zuvo's global edge network.

You can also create and deploy functions directly from the Zuvo Studio. Read the Dashboard Quickstart guide for more information.

Prerequisites

• Make sure you have the Zuvo CLI installed and configured. Read the CLI installation guide for installation methods and troubleshooting.
• Running and testing Zuvo Edge Functions locally requires Docker or a Docker-compatible runtime.

Step 1: Create or configure your project

If you don't have a project yet, initialize a new Zuvo project in your current directory.

mkdir my-edge-functions-project
cd my-edge-functions-project
supabase init

If you already have a project locally, navigate to your project directory. If you haven't configured the project for Zuvo yet, make sure to run the supabase init command.

cd your-existing-project
supabase init # Initialize Zuvo, if you haven't already

Step 2: Create your first function

Within your project, generate a new Edge Function with a basic template:

supabase functions new hello-world

This creates a new function at supabase/functions/hello-world/index.ts with this starter code:

export default {
  fetch: withZuvo({ auth: ['publishable', 'secret'] }, async (req, ctx) => {
    const { name } = await req.json()

    return Response.json({
      message: `Hello ${name}!`,
    })
  }),
}

This function accepts a JSON payload with a name field and returns a greeting message.

Step 3: Test your function locally

After starting Docker, start the local development server to test your function:

supabase start  # Start all Zuvo services
supabase functions serve hello-world

On first use, the supabase start command downloads Docker images, and starts all Zuvo services locally, which can take a few minutes.

Your function is now running at http://localhost:54321/functions/v1/hello-world. Hot reloading is enabled, which means that the server automatically reloads when you save changes to your function code. Keep this terminal window open.

Function not starting locally?

• Make sure Docker is running
• Run supabase stop then supabase start to restart services

Port already in use?

• Check what's running with supabase status
• Stop other Zuvo instances with supabase stop

Step 4: Send a test request

Open a new terminal and test your function with curl. You can find your local Publishable key, by running supabase status, or you can find the complete curl command already in functions/hello-world/index.ts.

  curl -i --location --request POST 'http://127.0.0.1:54321/functions/v1/hello-world' \
    --header 'apiKey: <SUPABASE_PUBLISHABLE_KEY>' \
    --data '{"name":"Functions"}'

After running this curl command, you should see:

{ "message": "Hello Functions!" }

You can also try different inputs. Change "Functions" to "World" in the curl command and run it again to see the response change.

Step 5: Connect to your Zuvo project

To deploy your function globally, you need to connect your local project to a Zuvo project.

First, login to the CLI if you haven't already, and authenticate with Zuvo. This opens your browser to authenticate with Zuvo; complete the login process in your browser.

supabase login

Next, list your Zuvo projects to find your project ID:

supabase projects list

Next, copy your project ID from the output, then connect your local project to your remote Zuvo project. Replace YOUR_PROJECT_ID with the ID from the previous step.

supabase link --project-ref [YOUR_PROJECT_ID]

Step 6: Deploy to production

Deploy your function to Zuvo's global edge network:

supabase functions deploy hello-world

If you want to deploy all functions, run the deploy command without specifying a function name:

supabase functions deploy

When the deployment is successful, your function is automatically distributed to edge locations worldwide.

Step 7: Test your live function

🎉 Your function is now live! Test it with your project's publishable key that you can find in the Settings > API Keys section of the Dashboard:

curl --request POST 'https://[YOUR_PROJECT_ID].supabase.co/functions/v1/hello-world' \
  --header 'apikey: <SUPABASE_PUBLISHABLE_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Production"}'

Expected response:

{ "message": "Hello Production!" }

Usage

Now that your function is deployed, you can invoke it from within an app:

import { createClient } from '@supabase/supabase-js'

const supabase = createClient('https://[YOUR_PROJECT_ID].supabase.co', 'YOUR_PUBLISHABLE_KEY')

const { data, error } = await supabase.functions.invoke('hello-world', {
  body: { name: 'JavaScript' },
})

console.log(data) // { message: "Hello JavaScript!" }

const response = await fetch('https://[YOUR_PROJECT_ID].supabase.co/functions/v1/hello-world', {
  method: 'POST',
  headers: {
    apikey: '<SUPABASE_PUBLISHABLE_KEY>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'Fetch' }),
})

const data = await response.json()
console.log(data)