> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nelkap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Nuxt

> Add Nelkap to a Nuxt app, from your keys to your first run.

This guide adds Nelkap to a Nuxt 4 app. By the end, your app will run a workflow that creates a new user's profile, waits a day, and sends them a welcome email, and you'll follow each step in your project.

You need a Nelkap project with its endpoint, an API key, and its secret. If you don't have them yet, follow the first three steps of the [quickstart](https://docs.nelkap.com/quickstart.md).

**1. Install the SDK**

```bash npm theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
npm install @nelkap/sdk
```

```bash pnpm theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
pnpm add @nelkap/sdk
```

```bash yarn theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
yarn add @nelkap/sdk
```

**2. Add your keys**

Add your project's API key and secret to `.env`:

```bash .env theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
NELKAP_API_KEY=your-api-key
NELKAP_SECRET=your-project-secret
```

In development, Nuxt loads this file into `process.env`, where the SDK reads both values. The API key lets your app start runs and save steps. The secret lets your app check that each call really comes from Nelkap.

Nuxt doesn't read `.env` in production, so set the same two variables in your host's settings when you deploy.

**3. Create your client and your first workflow**

Create `server/utils/nelkap.ts`. Code in the `server` folder only runs on the server, which keeps your keys out of the browser:

```ts server/utils/nelkap.ts theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
import { Nelkap } from '@nelkap/sdk';

import {
  createProfile,
  sendWelcomeEmail,
} from './activities';

export const nelkap = new Nelkap();

export async function onboardUser(userId: string) {
  await nelkap.step.run('profile', () =>
    createProfile(userId),
  );

  await nelkap.step.sleep('1 day');

  await nelkap.step.run('welcome', () =>
    sendWelcomeEmail(userId),
  );
}

nelkap.registerWorkflows([
  { name: 'onboardUser', handler: onboardUser },
]);
```

* `onboardUser` is your workflow: an async function that takes the run's payload, here a user ID.
* Each `step.run` saves what its function returns. When the run picks up after the sleep, the profile step gives back its saved result instead of creating the profile again.
* `step.sleep` pauses the run for a day. Nothing runs in your app during that day.
* `registerWorkflows` tells Nelkap which workflows your app runs, as soon as the file is loaded.

Replace `createProfile` and `sendWelcomeEmail` with your own functions.

**4. Add the route Nelkap calls**

Create a server route at the path of your endpoint. The `.post` in its name makes it answer POST requests only:

```ts server/api/nelkap.post.ts theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
import { nelkap } from '#server/utils/nelkap';

export default defineEventHandler((event) => {
  return nelkap.handle(toWebRequest(event), {
    waitUntil: (promise) => event.waitUntil(promise),
  });
});
```

`toWebRequest` turns Nuxt's request into the standard `Request` that `handle` takes. `handle` checks the secret, answers Nelkap at once, and runs the workflow in the background. [`event.waitUntil`](https://nuxt.com/docs/4.x/directory-structure/server#awaiting-promises-after-response) keeps that background work going once the answer is sent, on serverless hosts as on your own server.

If your app checks sign-in on every route, for example in a server middleware, leave `/api/nelkap` out: `handle` checks Nelkap's secret instead.

**5. Deploy your app**

Deploy your app with its two environment variables, so Nelkap can reach the route over the internet. Your project's endpoint must be the route's exact URL, like `https://your-app.com/api/nelkap`.

**6. Start a run**

Start the workflow from any server code. Here, the sign-up route starts it once the user is created:

```ts server/api/sign-up.post.ts theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
import { nelkap, onboardUser } from '#server/utils/nelkap';
import { createUser } from '#server/utils/users';

export default defineEventHandler(async (event) => {
  const user = await createUser(
    await readBody<{ email: string }>(event),
  );

  await nelkap.run(onboardUser, user.id);

  return { userId: user.id };
});
```

`run` returns as soon as Nelkap has the run, so the sign-up doesn't wait for the workflow. Its second argument, `user.id`, is the run's payload: Nelkap passes it to `onboardUser`.

**7. Follow your run**

Open your project's runs. The new run shows the profile step with what it returned, then sleeps. A day later, Nelkap calls your route again, the welcome email goes out, and the run completes.

## Long runs on serverless hosts

On a serverless host, `event.waitUntil` keeps a call going for as long as your function may run. If a call reaches that limit, every step already saved is kept, and Nelkap calls your app again about five minutes later to go on from there. Keep each step shorter than your host's limit.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.