trigger.dev icon indicating copy to clipboard operation
trigger.dev copied to clipboard

[TRI-1251] Framework: support for Redwood.js

Open samejr opened this issue 2 years ago • 20 comments

Build support for Redwood into Trigger.dev

Please make sure to use Typescript for all code

Task 1 - Redwood Adaptor

  • [ ] Create a new folder in packages called redwood
  • [ ] Create the adaptor for Redwood. Use this Next.js adaptor code as reference when creating yours. Include all setup configurations to fully support the framework, e.g. Next.js requires adaptor support for both App and Pages routers.
  • [ ] Create a basic Redwood project that uses the adaptor in examples/redwood folder. Include a basic Job in Trigger.dev, e.g. a simple Job that just does a delay inside it. Screen grab the full Run dashboard page showing it successfully worked. Here are examples of how to do cross-project references in package.json and tsconfig.json.
  • [ ] Provide a screen grab of your terminal showing the Adaptor is working

Task 2 – Add a README.md file

  • [ ] Create a new README.md file inside the packages/redwood folder and copy in the contents from packages/nextjs/README.md. Adjust the wording to reference Redwood where needed, including updating the the URLs.

Task 3 – Write the documentation

  • [ ] Locate the manual-setup-redwood.mdx folder in /docs/_snippets/. Use this file to write your documentation, overwriting any contents of that file. Follow the structure of this Next.js example for reference when writing yours.
  • [ ] Update the table at the bottom of the client-adaptors.mdx page with the framework you’ve worked on.

Task 4 – Update the webapp onboarding

  • [ ] In the route.tsx page located in _app.orgs.$organizationSlug.projects.$projectParam.setup.redwood replace the <FrameworkComingSoon/> component with your new onboarding steps. Follow the same structure as the Next.js example when creating your own. Ignore the very top step for adding this framework to a new project, just focus on the steps to add it to an existing project (so don’t include the <RadioGroup/> toggle selector at the top). Make sure you also include the useProjectSetupComplete(); hook at the top of the page – this triggers a particle effect when the new job is successfully created and redirects to the Jobs list 🥳 .
  • [ ] In the FrameworkSelector.tsx file, add “supported” to the framework you’ve worked on. CleanShot 2023-09-07 at 16 42 14

TRI-1251

samejr avatar Sep 08 '23 15:09 samejr

/bounty $200

samejr avatar Sep 08 '23 16:09 samejr

💎 $200 bounty • Trigger.dev (YC W23)

~~## 💎 $200 bounty • Trigger.dev (YC W23)~~

Steps to solve:

  1. Start working: Comment /attempt #448 with your implementation plan
  2. Submit work: Create a pull request including /claim #448 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Additional opportunities:

  • 🔴 Livestream on Algora TV while solving this bounty & earn $200 upon merge! Make sure to have your camera and microphone on. Comment /livestream once live

Thank you for contributing to triggerdotdev/trigger.dev!

Add a bountyShare on socials

algora-pbc[bot] avatar Sep 08 '23 16:09 algora-pbc[bot]

Can you assign this to me?

rishi-raj-jain avatar Sep 08 '23 17:09 rishi-raj-jain

This one is yours 👍

samejr avatar Sep 08 '23 18:09 samejr

Thanks, looks like Redwood is tough for people :) (just kidding @ajcwebdev)

rishi-raj-jain avatar Sep 08 '23 18:09 rishi-raj-jain

@rishi-raj-jain: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

algora-pbc[bot] avatar Sep 15 '23 17:09 algora-pbc[bot]

I'm working on it.

rishi-raj-jain avatar Sep 19 '23 08:09 rishi-raj-jain

The bounty is up for grabs! Everyone is welcome to /attempt #448 🙌

algora-pbc[bot] avatar Sep 22 '23 17:09 algora-pbc[bot]

/tip @rishi-raj-jain $200

matt-aitken avatar Oct 19 '23 15:10 matt-aitken

algora-pbc[bot] avatar Oct 19 '23 15:10 algora-pbc[bot]

/tip $200 @rishi-raj-jain

matt-aitken avatar Oct 19 '23 15:10 matt-aitken

🎉🎈 @rishi-raj-jain has been awarded $200! 🎈🎊

algora-pbc[bot] avatar Oct 19 '23 15:10 algora-pbc[bot]

This issue is currently on pause because RedwoodJS currently only supports the Yarn package manager: https://github.com/redwoodjs/redwood/issues/2907.

This means that it doesn't play nicely inside our repo. If we could get it work nicely we'd also have to make it so all the instructions in the app and docs only used yarn.

matt-aitken avatar Oct 19 '23 15:10 matt-aitken

Additionally here's a comment with a video showing the problem: https://github.com/triggerdotdev/trigger.dev/pull/598#issuecomment-1754963307

matt-aitken avatar Oct 19 '23 15:10 matt-aitken

Is this issue still on pause? @matt-aitken

Bhavyajain21 avatar Mar 10 '24 08:03 Bhavyajain21

Hey, we won’t be providing an official Redwood package for v2. Instead, v3 will be shipping in a few weeks and will not require any framework specific code: https://trigger.dev/blog/v3-announcement

samejr avatar Mar 11 '24 13:03 samejr

/attempt #448

HyperDanisH avatar Apr 24 '24 07:04 HyperDanisH

@HyperDanisH: Another person is already attempting this issue. Please don't start working on this issue unless you were explicitly asked to do so.

algora-pbc[bot] avatar Apr 24 '24 07:04 algora-pbc[bot]

Hey @HyperDanisH this bounty has already been claimed

samejr avatar Apr 24 '24 08:04 samejr

@samejr It's fine, I can further look for other bounties.

HyperDanisH avatar Apr 24 '24 10:04 HyperDanisH