Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

docs: Adding start script to node-server docs #5312

Closed
wants to merge 1 commit into from

Conversation

Chippd
Copy link

@Chippd Chippd commented Jun 6, 2022

When deploying to a service like Heroku, users will need to define a start script to avoid errors.

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

When trying to deploy a nuxt app to heroku, I received an error that there was no start script. My change is to update the node server documentation to include this start script.

This improves the developer experience for Nuxt developers. This change makes it quicker for developers to get something deployed, reducing frustration and increasing satisfaction with Nuxt

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

When deploying to a service like Heroku, users will need to define a start script to avoid errors.
@netlify
Copy link

netlify bot commented Jun 6, 2022

βœ… Deploy Preview for nuxt3-docs ready!

Name Link
πŸ”¨ Latest commit 5ffca23
πŸ” Latest deploy log https://app.netlify.com/sites/nuxt3-docs/deploys/629dfbf1fd768400097092c1
😎 Deploy Preview https://deploy-preview-5312--nuxt3-docs.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@pi0
Copy link
Member

pi0 commented Jun 8, 2022

Hi @Chippd and thanks for this PR. For Heroku deployments (and generally other deployments as well), all we need is .output directory (not the entire repo) I believe we can autogenerate a corresponding package.json file for it or opt-in for Docker before documenting this since in general, is not a good practice including all source code nor needed (related issue for the preset: unjs/nitro#49)

@pi0 pi0 added documentation Improvements or additions to documentation pending nitro upstream labels Jun 8, 2022
@Chippd
Copy link
Author

Chippd commented Jun 9, 2022

Fair enough, it did feel not-quite-right adding Heroku-specific config here but it should be somewhere, and I couldn't find it easily.

@pi0
Copy link
Member

pi0 commented Jul 7, 2022

Let's track in the upstream issue. Thanks for PR anyways <3

@pi0 pi0 closed this Jul 7, 2022
@danielroe danielroe added the 3.x label Jan 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
3.x documentation Improvements or additions to documentation nitro pending upstream
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants