templates(netlify): improve DX for Netlify serverless template #3754

nickytonline · 2022-07-15T15:27:32Z

This PR improves the DX when using the Netlify template to build out your Remix application. cc: @ascorbic. I've based this PR off of main because I believe @mcansh mentioned that if it's just template changes, there's no need to branch off of the dev branch.

Closes: #3753

Docs
Tests

Testing Strategy:

Create a new Remix application and select Netlify for the deployment target.
You can install whatever you'd like in the Remix CLI steps. It also doesn't matter if you select TypeScript or JavaScript
Once your application has been created, from a shell, change to the root directory of your new application.
Run npm run dev
The Remix dev server starts and renders the main page when navigating to http://localhost:3000
Stop the Remix dev server.
Run netlify dev. The server running on Netlify functions locally starts and renders the main page when navigating to http://localhost:3000.
Run netlify deploy --build. If you're application isn't configured to deploy yet, ensure you've followed the steps in the README first to get your app configured to deploy to Netlify.
The application builds and deploys. Navigate to the deploy preview. The site loads.

changeset-bot · 2022-07-15T15:27:34Z

⚠️ No Changeset found

Latest commit: 8138f2b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

remix-cla-bot · 2022-07-15T15:27:34Z

Hi @nickytonline,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

templates/netlify/remix.config.js

templates/netlify/package.json

remix-cla-bot · 2022-07-15T15:41:54Z

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

nickytonline · 2022-07-15T15:43:07Z

Before this gets merged, I'd like to have at least one of my team members approve it, so for the moment, I will put it back in draft.

templates/netlify/README.md

KyleBlankRollins

Thanks for tagging me, @nickytonline! Although I personally find "serverless server" hilarious, I'm not sure we want to use it in the docs.

Let me know if you have questions!

templates/netlify/README.md

Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com>

nickytonline · 2022-07-15T21:36:40Z

templates/netlify/remix.config.js

@@ -1,7 +1,10 @@
 /** @type {import('@remix-run/dev').AppConfig} */
 module.exports = {
  serverBuildTarget: "netlify",
-  server: "./server.js",
+  server:


This check is to ensure we do not start the Netlify function to run the Remix app server when running npm run dev, i.e. remix dev as you can't run a custom server via remix dev. Without this check, if you run remix dev it will error out with the following message:

Error: remix dev is not supported for custom servers. at Object.dev (/Users/some_user/dev/issues/remix-tailwind/node_modules/@remix-run/dev/cli/commands.js:260:11) at processTicksAndRejections (node:internal/process/task_queues:96:5) at Object.run (/Users/some_user/dev/issues/remix-tailwind/node_modules/@remix-run/dev/cli/run.js:499:7) ERROR: "dev:remix" exited with 1.

kentcdodds

Thank you!

…-run#3754) * chore: improve DX for Netlify serverless template * added myself as a contributor to Remix * chore: updated some documentation * changed conditional check for generating Remix config * Update templates/netlify/README.md Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com> * Update templates/netlify/README.md Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com> * Update templates/netlify/README.md Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com> * chore: added a link to Netlify Functions in the Netlify README * updated deployment commands Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com>

remix-run/remix#3754

matching the default netlify template remix-run/remix#3754 https://github.com/remix-run/remix/tree/main/templates/netlify

devraj · 2023-04-29T05:50:48Z

@nickytonline I was wondering if this was released? I still see something similar in 1.15 and the app ends up with hydration exceptions. The original issue is now locked hence posting here

nickytonline · 2023-04-30T13:38:14Z

@devraj, the home for the Netlify templates can now be found in this Remix stack, https://github.com/netlify/remix-template. The CLI still points to the one that only supports the Netlify Functions template.

Kent or others, I know long term, folks are encouraged to build their templates outside of the repo, but given that Netlify is still an option in the CLI like Vercel, Deno etc., could we point to the https://github.com/netlify/remix-template Stack instead when someone selects Netlify?

Happy to create a PR for this.

machour · 2023-04-30T13:41:05Z

@nickytonline Your best course of action here is to create a new proposal in the discussions tab 🙏🏼

devraj · 2023-04-30T22:33:54Z

@devraj, the home for the Netlify templates can now be found in this Remix stack, https://github.com/netlify/remix-template. The CLI still points to the one that only supports the Netlify Functions template.

Kent or others, I know long term, folks are encouraged to build their templates outside of the repo, but given that Netlify is still an option in the CLI like Vercel, Deno etc., could we point to the https://github.com/netlify/remix-template Stack instead when someone selects Netlify?

Happy to create a PR for this.

I agree. If that repo is what is kept up to date, then it would save everyone deploying to Netlify a lot of time. Appreciate you taking the time to post a response..

nickytonline · 2023-05-02T20:13:27Z

@devraj, just FYI, the CLI is getting updated with the official template. See #6281

chore: improve DX for Netlify serverless template

cc86eec

nickytonline commented Jul 15, 2022

View reviewed changes

templates/netlify/remix.config.js Outdated Show resolved Hide resolved

templates/netlify/package.json Show resolved Hide resolved

nickytonline marked this pull request as ready for review July 15, 2022 15:40

added myself as a contributor to Remix

9b15f14

remix-cla-bot bot added the CLA Signed label Jul 15, 2022

machour added template:netlify and removed CLA Signed labels Jul 15, 2022

nickytonline marked this pull request as draft July 15, 2022 15:43

nickytonline commented Jul 15, 2022

View reviewed changes

templates/netlify/README.md Outdated Show resolved Hide resolved

Merge branch 'main' into update-netlify-functions-template

93a9227

remix-cla-bot bot added the CLA Signed label Jul 15, 2022

chore: updated some documentation

1fb52c8

ascorbic reviewed Jul 15, 2022

View reviewed changes

templates/netlify/README.md Outdated Show resolved Hide resolved

changed conditional check for generating Remix config

b19f8f1

KyleBlankRollins reviewed Jul 15, 2022

View reviewed changes

nickytonline and others added 5 commits July 15, 2022 16:17

Update templates/netlify/README.md

1b7ed45

Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com>

Update templates/netlify/README.md

fa7bbc5

Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com>

Update templates/netlify/README.md

433b0f0

Co-authored-by: Kyle Rollins <kyleblankrollins@gmail.com>

chore: added a link to Netlify Functions in the Netlify README

6304e22

updated deployment commands

8138f2b

nickytonline marked this pull request as ready for review July 15, 2022 21:12

nickytonline commented Jul 15, 2022

View reviewed changes

MichaelDeBoey changed the title ~~chore: improve DX for Netlify serverless template~~ templates(netlify): improve DX for Netlify serverless template Jul 16, 2022

MichaelDeBoey approved these changes Jul 16, 2022

View reviewed changes

MichaelDeBoey assigned kentcdodds Jul 16, 2022

kentcdodds approved these changes Jul 16, 2022

View reviewed changes

kentcdodds merged commit 99d98bd into remix-run:main Jul 16, 2022

nickytonline deleted the update-netlify-functions-template branch July 16, 2022 16:20

nickytonline mentioned this pull request Jul 19, 2022

chore: improve DX for the Edge template netlify/remix-template#44

Merged

juliuxu added a commit to capraconsulting/nettsiden that referenced this pull request Sep 9, 2022

🧑‍💻 use remix dev server for development

ea1abfe

remix-run/remix#3754

juliuxu added a commit to capraconsulting/nettsiden that referenced this pull request Oct 6, 2022

🔧 use the remix dev server to run locally

1fb5d74

matching the default netlify template remix-run/remix#3754 https://github.com/remix-run/remix/tree/main/templates/netlify

devraj mentioned this pull request Apr 29, 2023

Consider turning this repository into a remix-stack anomaly/lab-python-server#70

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

templates(netlify): improve DX for Netlify serverless template #3754

templates(netlify): improve DX for Netlify serverless template #3754

nickytonline commented Jul 15, 2022 •

edited

Loading

changeset-bot bot commented Jul 15, 2022 •

edited

Loading

remix-cla-bot bot commented Jul 15, 2022

remix-cla-bot bot commented Jul 15, 2022

nickytonline commented Jul 15, 2022 •

edited

Loading

KyleBlankRollins left a comment

nickytonline Jul 15, 2022 •

edited

Loading

kentcdodds left a comment

devraj commented Apr 29, 2023

nickytonline commented Apr 30, 2023

machour commented Apr 30, 2023

devraj commented Apr 30, 2023

nickytonline commented May 2, 2023

templates(netlify): improve DX for Netlify serverless template #3754

templates(netlify): improve DX for Netlify serverless template #3754

Conversation

nickytonline commented Jul 15, 2022 • edited Loading

changeset-bot bot commented Jul 15, 2022 • edited Loading

⚠️ No Changeset found

remix-cla-bot bot commented Jul 15, 2022

remix-cla-bot bot commented Jul 15, 2022

nickytonline commented Jul 15, 2022 • edited Loading

KyleBlankRollins left a comment

Choose a reason for hiding this comment

nickytonline Jul 15, 2022 • edited Loading

Choose a reason for hiding this comment

kentcdodds left a comment

Choose a reason for hiding this comment

devraj commented Apr 29, 2023

nickytonline commented Apr 30, 2023

machour commented Apr 30, 2023

devraj commented Apr 30, 2023

nickytonline commented May 2, 2023

nickytonline commented Jul 15, 2022 •

edited

Loading

changeset-bot bot commented Jul 15, 2022 •

edited

Loading

nickytonline commented Jul 15, 2022 •

edited

Loading

nickytonline Jul 15, 2022 •

edited

Loading