Matt Aitken
9ff4c0dbd5
* Setup project-wide prettier * Remove old workspace file * Remove old debugging directives * New top-level .prettierignore * Updated Prettier config settings * Contrubuting guide: Fix for some bad code blocks * Added more ignores * Improved the format script command * printWidth set to 100 * Formatted entire repo (pnpm run format)
66 lines
3.0 KiB
Markdown
66 lines
3.0 KiB
Markdown
<div align="center">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public">
|
||
<source media="(prefers-color-scheme: light)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/3f5ad4c1-c4c8-4277-b622-290e7f37bd00/public">
|
||
<img alt="Trigger.dev logo" src="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public">
|
||
</picture>
|
||
|
||
### The background jobs framework for Next.js
|
||
|
||
[Discord](https://discord.gg/JtBAxBr2m3) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger.dev/docs)
|
||
|
||
[](https://twitter.com/triggerdotdev)
|
||
[](https://github.com/triggerdotdev/trigger.dev)
|
||
|
||
</div>
|
||
|
||
# About Trigger.dev
|
||
|
||
Create long-running jobs directly in your codebase with features like API integrations, webhooks, scheduling and delays.
|
||
|
||
### Long running Jobs on serverless
|
||
|
||
Reliably run jobs and don’t worry about function timeouts, we handle those for you.
|
||
|
||
- Auto-resume after a function timeout
|
||
- Auto-resume after a server outage
|
||
- Add delays of up to a year
|
||
|
||
### In your codebase
|
||
|
||
Create Jobs where they belong: in your codebase. Version control, localhost, test, review, and deploy like you're already used to.
|
||
|
||
### Secure by design
|
||
|
||
We only receive Triggers and the data you choose to send to us. You can even completely self-host the entire platform.
|
||
|
||
### Don't worry about deployment
|
||
|
||
Just use our SDK to write Jobs in your Next.js codebase. There's nothing extra to deploy and no CI to configure, your Jobs just connect to our cloud. Or you can always self-host.
|
||
|
||
### Full visibility of every job run
|
||
|
||
View every Task in every Run so you can tell exactly what happened.
|
||
|
||
|
||
|
||
### Built-in integrations
|
||
|
||
Easily integrate with hundreds of third-party APIs – including your own. Use API keys (which never leave your server) or let us handle OAuth for you. Install our integration packages and easily subscribe to webhooks and perform common tasks, or you can easily use your existing favorite Node.JS SDKs and get resumability and idempotency through our `runTask` function.
|
||
|
||
### Trigger.dev Connect (coming soon)
|
||
|
||
Easily add integrations for your users.
|
||
|
||
# Getting started
|
||
|
||
Visit our docs [here](https://trigger.dev/docs).
|
||
|
||
## Self-host
|
||
|
||
We provide an official trigger.dev docker image you can use to easily self-host the platform. We're working on more extensive guides but we currently provide a [Fly.io example repository](https://github.com/triggerdotdev/fly.io) with instructions in the README for deploying and using a self-hosted instance of Trigger.dev on Fly.io.
|
||
|
||
## Development
|
||
|
||
To setup and develop locally or contribute to the open source project, follow our [developement guide](./CONTRIBUTING.md).
|