Skip to content

Docs/community packages #1714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ jobs:
${{ runner.os }}-mintlify

- name: 🔗 Check for broken links
run: npx [email protected].222 broken-links
run: npx [email protected].393 broken-links
12 changes: 9 additions & 3 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@
"dropdown": "Guides & examples",
"description": "A great way to get started",
"icon": "book",

"groups": [
{
"group": "Introduction",
Expand All @@ -213,7 +214,7 @@
"guides/frameworks/nextjs",
"guides/frameworks/nodejs",
"guides/frameworks/remix",
"guides/frameworks/sveltekit"
"guides/community/sveltekit"
]
},
{
Expand Down Expand Up @@ -298,8 +299,13 @@
]
},
{
"group": "Migrations",
"pages": ["guides/use-cases/upgrading-from-v2"]
"group": "Community packages",
"pages": [
"guides/community/dotenvx",
"guides/community/fatima",
"guides/community/rate-limiter",
"guides/community/sveltekit"
]
}
]
}
Expand Down
10 changes: 10 additions & 0 deletions docs/guides/community/dotenvx.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "dotenvx"
sidebarTitle: "dotenvx"
description: "A dotenvx package for Trigger.dev."
icon: "square-e"
---

This is a community developed package from [dotenvx](https://dotenvx.com/) that enables you to use dotenvx with Trigger.dev.

[View the docs](https://dotenvx.com/docs/background-jobs/triggerdotdev)
12 changes: 12 additions & 0 deletions docs/guides/community/fatima.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Fatima"
sidebarTitle: "Fatima"
description: "A Fatima package for Trigger.dev."
icon: "f"
---

This is a community developed package from [@Fgc17](https://github.com/Fgc17) that enables you to use Fatima with Trigger.dev.

[View the Fatima docs](https://fatimajs.vercel.app/docs/adapters/trigger)

[View the repo](https://github.com/Fgc17/fatima)
10 changes: 10 additions & 0 deletions docs/guides/community/rate-limiter.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Rate limiter"
sidebarTitle: "Rate limiter"
description: "A rate limiter for Trigger.dev."
icon: "gauge-simple-low"
---

This is a community developed package from [@ian](https://github.com/ian) that uses Redis to rate limit Trigger.dev tasks.

[View the repo](https://github.com/ian/trigger-rate-limiting)
31 changes: 31 additions & 0 deletions docs/guides/community/sveltekit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "SvelteKit setup guide"
sidebarTitle: "SvelteKit"
description: "A plugin for SvelteKit to integrate with Trigger.dev."
icon: "s"
---

import Prerequisites from "/snippets/framework-prerequisites.mdx";

This is a community developed Vite plugin from [@cptCrunch_](https://x.com/cptCrunch_) that enables seamless integration between SvelteKit and Trigger.dev by allowing you to use your SvelteKit functions directly in your Trigger.dev projects.

## Features

- Use SvelteKit functions directly in Trigger.dev tasks
- Automatic function discovery and export
- TypeScript support with type preservation
- Preserves JSDoc documentation
- Hot Module Reloading support
- Configurable directory scanning

<Prerequisites framework="SvelteKit" />

## Setup

[View setup guide on npm](https://www.npmjs.com/package/vite-plugin-triggerkit)

```bash
npm i vite-plugin-triggerkit
```

<UsefulNextSteps />
22 changes: 0 additions & 22 deletions docs/guides/frameworks/sveltekit.mdx

This file was deleted.

12 changes: 6 additions & 6 deletions docs/guides/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ mode: "center"
<Card title="Next.js" img="/images/logo-nextjs.png" href="/guides/frameworks/nextjs"/>
<Card title="Node.js" img="/images/logo-nodejs.png" href="/guides/frameworks/nodejs"/>
<Card title="Remix" img="/images/logo-remix.png" href="/guides/frameworks/remix"/>
<Card title="SvelteKit" img="/images/logo-svelte.png" href="/guides/frameworks/sveltekit"/>
<Card title="SvelteKit" img="/images/logo-svelte.png" href="/guides/community/sveltekit"/>
</CardGroup>


Expand All @@ -39,12 +39,12 @@ Get set up fast using our detailed walk-through guides.

Example projects are full projects with example repos you can fork and use. These are a great way of learning how to encorporate Trigger.dev into your project.

| Example project | Description | Framework | GitHub Repo |
| Example project | Description | Framework | GitHub |
| :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | :-------- | :---------------------------------------------------------------------------------------------------- |
| [Realtime Fal.ai image generation](/guides/example-projects/realtime-fal-ai) | Generate an image from a prompt using Fal.ai and show the progress of the task on the frontend using Realtime. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-fal-ai-image-generation) |
| [Batch LLM Evaluator](/guides/example-projects/batch-llm-evaluator) | Evaluate multiple LLM models and stream the results to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/batch-llm-evaluator) |
| [Realtime CSV Importer](/guides/example-projects/realtime-csv-importer) | Upload a CSV file and see the progress of the task streamed to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-csv-importer) |
| [Vercel AI SDK image generator](/guides/example-projects/vercel-ai-sdk-image-generator) | Use the Vercel AI SDK to generate images from a prompt. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator) |
| [Realtime Fal.ai image generation](/guides/example-projects/realtime-fal-ai) | Generate an image from a prompt using Fal.ai and show the progress of the task on the frontend using Realtime. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/realtime-fal-ai-image-generation) |
| [Batch LLM Evaluator](/guides/example-projects/batch-llm-evaluator) | Evaluate multiple LLM models and stream the results to the frontend. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/batch-llm-evaluator) |
| [Realtime CSV Importer](/guides/example-projects/realtime-csv-importer) | Upload a CSV file and see the progress of the task streamed to the frontend. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/realtime-csv-importer) |
| [Vercel AI SDK image generator](/guides/example-projects/vercel-ai-sdk-image-generator) | Use the Vercel AI SDK to generate images from a prompt. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator) |

## Example tasks

Expand Down
2 changes: 1 addition & 1 deletion docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ mode: "center"

Trigger.dev is an open source background jobs framework that lets you write reliable workflows in plain async code. Run long-running AI tasks, handle complex background jobs, and build AI agents with built-in queuing, automatic retries, and real-time monitoring. No timeouts, elastic scaling, and zero infrastructure management required.

We provide everything you need to build and manage background tasks: a [CLI and SDK](/config/config-file) for writing tasks in your existing codebase, support for both [regular](/tasks-regular) and [scheduled](/tasks/scheduled) tasks, full observability through our dashboard, and a [Realtime API](/realtime) with [React hooks](/frontend/react-hooks#realtime-hooks) for showing task status in your frontend. You can use [Trigger.dev Cloud](https://cloud.trigger.dev) or [self-host](/open-source-self-hosting) on your own infrastructure.
We provide everything you need to build and manage background tasks: a [CLI and SDK](/config/config-file) for writing tasks in your existing codebase, support for both [regular](/tasks/overview) and [scheduled](/tasks/scheduled) tasks, full observability through our dashboard, and a [Realtime API](/realtime) with [React hooks](/frontend/react-hooks#realtime-hooks) for showing task status in your frontend. You can use [Trigger.dev Cloud](https://cloud.trigger.dev) or [self-host](/open-source-self-hosting) on your own infrastructure.

## Learn the concepts

Expand Down
Loading