Skip to content

docs: document alternative approach for local development #8

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

Merged
merged 1 commit into from
Apr 16, 2025

Conversation

sebjacobs
Copy link

Whilst recently attempting to test some changes to the webpack config we struggled to get npm link to work.

We ended up using an alternative approach using npm pack which generates a tarball of the npm package which you can then npm install into your other project.

In order to help future developers who find themselves in a similar situation I thought it was worth documenting this alternative approach.

Copy link

@floehopper floehopper left a comment

Choose a reason for hiding this comment

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

This looks good to me 👍

A couple of minor subjective points:

  • It might be better to use ScratchFoundation as the org name in the RaspberryPiFoundation-scratch-gui-4.1.0-beta.1.tgz example filename.
  • I think it would make more sense to include the new section after the "Getting another repo to point to this code (using npm link)" section, i.e. just after the "Oh no! It didn't work!" section and just before the "Testing" section. What do you think?

Whilst recently attempting to test some changes to the webpack config we
struggled to get `npm link` to work.

We ended up using an alternative approach using `npm pack` which generates a
tarball of the npm package which you can then `npm install` into your other
project.

In order to help future developers who find themselves in a similar situation I
thought it was worth documenting this alternative approach.
@sebjacobs sebjacobs force-pushed the seb-testing-locally-instructions branch from cf638ef to 276c402 Compare April 16, 2025 11:45
@sebjacobs sebjacobs merged commit 72bcaca into experience-cs Apr 16, 2025
2 checks passed
@sebjacobs sebjacobs deleted the seb-testing-locally-instructions branch April 24, 2025 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants