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

Installing with Yarn #34

Open
jmwamser opened this issue Aug 2, 2024 · 1 comment
Open

Installing with Yarn #34

jmwamser opened this issue Aug 2, 2024 · 1 comment

Comments

@jmwamser
Copy link

jmwamser commented Aug 2, 2024

This could totally be just a development setup issue and adding documentation to the Readme. Wanted to get your input before sending you a PR.

I included this project and went to install the packages. I use yarn instead of npm. At first all I would get is:
error Can't add "@sensiolabs/storybook-symfony-webpack5": invalid package version "".

With further looking into this I found https://stackoverflow.com/q/78287068

I should also note I am using FNM, so when I go into a directory my node version changes for me.

Here are the steps I took to resolve my issue:

  1. add .nvmrc with contents of 20.0
  2. in terminal went up a directory then back into project. (This made sure my node version was a 20)
  3. ran yarn set version stable (this set up my yarn version to 4.3.1) I did notice in the repo package.json it says yarn at 4.1.1 I don't think this should be a huge deal.
  4. then run yarn to install packages and everything worked fine

Would you like any of this added via PR to the readme? or any updates to the Recipe notes?

Looking forward to helping out!

@squrious
Copy link
Collaborator

squrious commented Aug 5, 2024

Hello @jmwamser, thanks for the issue! Yes, this would be great if the installation with yarn is documented as well.

WDYT about splitting README.md#installation into sub sections, like "Install with NPM" and "Install with Yarn"? Also, is the .nvmrc step really relevant here? I feel like it's specific to NVM, so I'd tend to not include it.

The storybook:init command could be updated to display a link to this installation section, like "Want to use Yarn instead of NPM? Check https://github.com/sensiolabs/StorybookBundle/blob/main/README.md#installation". So the recipe won't need an update for this.

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

No branches or pull requests

2 participants