Skip to content

Feat/remix support#465

Merged
matt-aitken merged 22 commits intotriggerdotdev:mainfrom
Chigala:feat/remix-support
Sep 11, 2023
Merged

Feat/remix support#465
matt-aitken merged 22 commits intotriggerdotdev:mainfrom
Chigala:feat/remix-support

Conversation

@Chigala
Copy link
Copy Markdown
Contributor

@Chigala Chigala commented Sep 11, 2023

Task 1 - Remix Adapter

  • Created a new folder in packages called remix.
  • Created a basic Remix project that uses the adapter. Place it in the examples/remix-example folder.
  • Included a basic Job in the remix project
  • Provide a screenshot of your terminal and the dashboard showing that the Adapter is working.
Screenshot 2023-09-11 at 6 38 17 AM Screenshot 2023-09-11 at 6 39 03 AM Screenshot 2023-09-11 at 6 39 12 AM

Task 2 - Add a README.md file

  • Created a new README.md file inside the packages/remix folder.

Task 3 - Write the documentation

  • Added the remix. manual-setup-guide manual-setup-remix.mdx file in /docs/_snippets/.
  • Updated the table at the bottom of the client-adaptors.mdx page with the remix framework.

Task 4 - Update the webapp onboarding

  • In the route.tsx page located in _app.orgs.$organizationSlug.projects.$projectParam.setup.remix, replaced the <FrameworkComingSoon/> component with new onboarding steps.
  • In the FrameworkSelector.tsx file, add "supported" to the framework you’ve worked on.

I didn't include trigger init CLI support for the framework because I don't know what the Trigger team has in mind concerning how to handle initialization for the other separate frameworks. If this is needed I don't mind implementing it. I'll also love your feeback on this!

/claim #445
/closes #445

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Sep 11, 2023

🦋 Changeset detected

Latest commit: ac04830

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

For now, we'll only support existing projects. The button that links to the manual installation was just a blank rectangle – added some text to it.
Made some things a bit clearer
- file paths
- exporting the job rather than using a function wrapper
- how to run the app and CLI dev command
Copy link
Copy Markdown
Member

@matt-aitken matt-aitken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few changes:

  • The blank project page in the app was broken – there was a button with no text so it was just a rectangle. I also improved the text a bit.
  • I made some of the docs a bit more specific
  • I dealt with the code stripping a bit differently from how you suggested, by exporting instead. Neither are ideal to be honest but I think it's the best we can do because of how Remix works with side effects.
  • Some tsconfig paths were missing
  • "next" was a dependency of the remix package
  • A specific version of Remix was in the main dependencies of the package. This would have caused issues with users who were on different versions. I moved it do be a devDependency only.

Shouldn't rely on a specific version in main dependencies. In this case we can just have devDependency for @remix/node
@matt-aitken
Copy link
Copy Markdown
Member

@Chigala I made a few changes, detailed in the comment above. It would be great if you could look at your other adaptor PRs and make the same changes where they are relevant

@matt-aitken matt-aitken merged commit b007177 into triggerdotdev:main Sep 11, 2023
@Chigala
Copy link
Copy Markdown
Contributor Author

Chigala commented Sep 12, 2023

@matt-aitken Thanks for the changes you made! I'll update the other adaptor PR I sent to follow suit where relevant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[TRI-1249] Framework: Support for Remix

2 participants