Deploy your first function

This guide walks through writing a small function that greets a visitor by name and deploying it to the edge.

Project layout

A fresh nimbus init project looks like this:

• Directorymy-app

  • Directoryfunctions

    • hello.ts
  • nimbus.config.ts
  • package.json

Write the function

1. Open functions/hello.ts and replace its contents:

   functions/hello.ts

   export default function handler(request: Request) {
     const url = new URL(request.url);
     const name = url.searchParams.get('name') ?? 'world';
   
     return new Response(`Hello, ${name}!`);
   }

2. Run it locally:

   nimbus dev

   curl "http://localhost:8787/hello?name=Ferris"
   # Hello, Ferris!

3. Deploy to every region:

   nimbus deploy

Caution

Functions are publicly reachable as soon as they’re deployed. Add an auth check before deploying anything that touches private data.

Check it shipped

nimbus logs hello --tail

You should see a request logged for each invocation, including the region that served it.

Further reading

• Environment variables — pass secrets and config into a function.
• Custom domains — replace the generated *.nimbus.dev URL.