Skip to content

Explain the -g pattern in documentation is for generating only, not to run storybook itself #916

@TheJaredWilcurt

Description

@TheJaredWilcurt

It's widely considered to be an anti-pattern to request that people globally install your Node Module. You shouldn't have to have Grunt, Bower, Webpack, Rollup, Storybook, etc, etc, etc, added to your system's global PATH.

Further, it can cause version issues. If the project I am using was written expecting an older version of X, but the newer, globally installed, version doesn't work with the project. Had the project just listed X in the devDependencies and accessed it via a npm run scriptName then when I ran npm install I'd have the correct version downloaded locally, and when I run it via npm run whatever it will use the correct version.

There should be documentation showing how to get start-storybook/build-storybook to run locally without adding anything to the PATH.

In order to run someone else's project, the expectation should be just to run npm install and npm start. If you have to globally install something, you're adding barriers of entry to getting more people to contribute.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions