James Ritchie
65fa8300ad
* Removed next references in the ReadMe * FAQ improvements to update Next.js references * Added a new Frameworks page with logos to link to the quick start guides * Renamed the mdx file so the link works * Added basic platform guides * Introduction doesn’t reference next.js only * Added a note about serverless and restructured the side menu * Added more frameworks pages to the manual install section * Fixed SVG error * Coming soon guides now using snippets so they can be in 2 places while we work on them * Removed redirects * Added a new named icon * increased fireworks particle count slightly * Creating a route for the onboarding and link to access it anytime from the side menu * Moved the onboarding into new components * Updated the routes for the onboarding page * Onboarding is now Setup and the frameworks overview page now links to different framework page in the onboarding side nav * URLs and pages renamed to ‘setup’ * URLs and pages renamed to ‘setup’ * Fixed some old named component imports * WIP on a new less hacked-in background image * Added svg logos for all the frameworks * New paths for the new framework pages * Side menu collapses once you selected a framework * Temporary Nuxt page * New routes for the new frameworks * New ‘framework coming soon’ component - now used in the coming soon framework pages * Moved/removed files * Moved all svg framework logos into a new folder and file * balanced the logo sizes * Framework coming soon pages take a name and url * New express svg logo * New component for a Framework item in the grid * Added information and design for the coming soon frameworks * Change the grid to 1 row if jobs === 0 * Updated the framework coming soon snippet and added it to the relevant pages * Express now 2nd in all lists * Added link to long running server support discussion * New logo to include next.js + supabase quick start * roadmap now links to homepage with page anchor to roadmap section * changelog now links to Github releases page * Removed reference to Next.js * Docs pages with coming soon info all share the same framework snippets * Fixed issue of missing props * Moved the fireworks effect into a separate file to make it easier for adding more framework onboarding pages * Info callouts have a more muted style * Added a callout to the top of the next onboarding to reference Serverless-only support * Moved the callout explaining scheduled triggers not working in dev to the bottom of the test panel This is to resolve eric’s UX ticket: https://github.com/triggerdotdev/trigger.dev/issues/416 * Added groundwork for Nest.js framework * Using framer motion for the menu transition instead of css - now has a slight spring and is snappier * redirect the manual setup page to the new nextjs setup page * Fixed broken docs link * Added a readme.md to next.js package * Capital I for integration * Renamed component: NextDevCommand to RunDevCommand * Made required props non-optional * CLI now points at manual install guides if no Next project detected * Explicitly made supported default to false (it was working but a bit hard to read) * Added links to all github issues for the frameworks coming soon component --------- Co-authored-by: Matt Aitken <matt@mattaitken.com>
86 lines
5.7 KiB
Markdown
86 lines
5.7 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 open source background jobs framework
|
||
|
||
[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 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.
|
||
|
||
## Our progress
|
||
|
||
We’re building the most comprehensive and easy-to-use background jobs framework for developers.
|
||
|
||
Click the links to join the discussions about our upcoming features.
|
||
|
||
| Feature | What it does | Status |
|
||
| ------------------------------------------------------------------------------------ | --------------------------------------------------- | ------ |
|
||
| Integration kit | Official Trigger.dev integrations or build your own | ✅ |
|
||
| Self-hosting | Host the platform yourself | ✅ |
|
||
| Cloud | Just write code, no deployment required | ✅ |
|
||
| Dashboard | View every Task in every Run | ✅ |
|
||
| Serverless | Long-running Jobs on your serverless backend | ✅ |
|
||
| React hooks | Easily update your UI with Job progress | ✅ |
|
||
| [Background tasks](https://github.com/triggerdotdev/trigger.dev/discussions/400) | Offload long or intense Tasks to our infrastructure | 🛠️ |
|
||
| [React frameworks](https://github.com/triggerdotdev/trigger.dev/discussions/411) | Support for Remix, Astro, RedwoodJS & more | 🛠️ |
|
||
| [Long-running servers](https://github.com/triggerdotdev/trigger.dev/discussions/430) | Run Jobs on your long-running backend | 🛠️ |
|
||
| Polling Triggers | Subscribe to changes without webhooks | 🕝 |
|
||
| Vercel integration | Easy deploy and preview environment support | 🕝 |
|
||
| Streaming | Receive data from your Jobs in realtime | 🕝 |
|
||
| 100+ integrations | Comprehensive support for popular APIs | 🕝 |
|
||
| [Trigger.dev Connect](https://github.com/triggerdotdev/trigger.dev/discussions/441) | Use integrations signed in as your users | 🕝 |
|
||
| File IO | Create Tasks that have file outputs | 🕝 |
|
||
|
||
# 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 [development guide](./CONTRIBUTING.md).
|