Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update npm.md #29474

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

SamamaKarim092
Copy link

Added in the Additional resources

What is npx?
Difference between npm and npx

Because

This PR adds useful resources to the "Additional Resources" section of the lesson. The links cover:

These topics help learners understand the purpose and usage of npx and how it differs from npm.

This PR

Added two new links in the "Additional Resources" section:

This improves the lesson by providing external references for deeper understanding.

Issue

This PR does not close an existing issue but enhances the curriculum by adding helpful resources.

Additional Information

No further discussions needed. Just an improvement to the Additional Resources section.

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

Added in the Additional resources
What is npx?
Difference between npm and npx
@github-actions github-actions bot added the Content: JavaScript Involves the JavaScript course label Mar 2, 2025
Copy link
Contributor

@MaoShizhong MaoShizhong left a comment

Choose a reason for hiding this comment

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

I don't think it makes sense to have these in the npm lesson because npx doesn't get mentioned anywhere. The first time the difference between npm and npx gets mentions is in Revisiting Webpack and the end of the npm.script section already explains that "npx" was only needed before to run the packages locally without an npm script (hence they're dropped in the scripts).

I wonder what the team think, but I feel that doesn't really need diving much further into npx or the difference between the two.

If there is value in linking a resource about the difference, I think something short, simple and accurate (the geekforgeeks article has an error in its example about the npm scripts and how you run them) should be linked inline with the lesson explanation, as opposed to being an additional resource. The npm docs on npx don't feel particularly helpful at this stage and would likely confuse people more or send people down rabbit holes IMO.

@SamamaKarim092
Copy link
Author

SamamaKarim092 commented Mar 2, 2025

That makes sense! I see now that npx isn’t mentioned in this lesson, and its explanation comes later in the curriculum. I agree that adding these links here might not be the best fit. If the team thinks it's valuable, I’d be happy to contribute a more concise and accurate resource in the relevant section instead. Would it make sense to add these links to the Revisiting Webpack lesson under Additional Resources, since that's where the difference between npm and npx is first mentioned? Thanks for the clarification!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: JavaScript Involves the JavaScript course
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants