uptick / react-keyed-file-browser

Folder based file browser given a flat keyed list of objects, powered by React.
MIT License
301 stars 144 forks source link

issue/135 Clarify contents of npm package #138

Closed oliverfoster closed 4 years ago

oliverfoster commented 4 years ago

resolves #135

Changed

scaredcat commented 4 years ago

I agree that it's a bit weird including the src folder, especially if the webpack config to build it is not included. I think typically you'd want to keep what is uploaded to npm as small as possible to minimize download time. Since this is an open source project you'd always be able to find the relevant source files on github. I'd recommend taking the following approach:

When installing the package into a new project, currently we have this:

Screen Shot 2020-08-24 at 11 20 30 am

and ideally we'd want this:

Screen Shot 2020-08-24 at 11 22 27 am

we'd have to:

  1. update .npmignore file to exclude source/config/setup files
  2. update the build script to copy the sass files available in the dist folder
oliverfoster commented 4 years ago

That sounds excellent. I'll close this pr and leave someone else who knows better what they're doing to pick up that work. Thanks for responding.